Implement new release_version command / method to support versioning of the BIDS and collab project datasets of the HIP

[sebastientourbier]

To support versioning of the BIDS and collab project datasets, the dataset.release_version command and release_version(input_data, output_file) method need to be implemented.

Input

• Absolute path to JSON file containing the following specified attributes:
• "dataset": Absolute path to the Datalad-managed BIDS / Collab project dataset
• "release_type": can be "patch" (for 1.0.0 -> 1.0.1), "minor" (for 1.0.1 -> 1.1.0), and "major" (for 1.1.0 -> 2.0.0).
• "changes": array of string describing each change.

Output

• Absolute path to JSON file containing the dataset summary of the dataset for which the version release was made or an error message.

Description

Make a new version release of (1) a BIDS dataset of the public space and the private space of the user, and (2) the project dataset of the collab space of the HIP.

This should perform the following steps depicted in the diagram below:

• Check if the dataset exists. If not, return an error message.
• Compute the new version tag based on the release_type.
• Make the version release of the BIDS / collab project dataset.
• Get a summary of the version-released dataset in JSON format.
• Save and return the dataset summary as an output JSON file.

Process diagram for the release_version(input_data, output_file) method

flowchart TB
    in0(["input_data"])
    c1{"Dataset exists?"}
    p2["Compute new version tag"]
    p3["Tag dataset"]
    out0(["output_file"])
    err0(["error"])
    subgraph "input"
    in0
    end
    in0-->c1
    subgraph "`release_version()`"
    c1-->|YES|p2-->p3
    end
    subgraph "output"
    p3-->out0
    c1-->err0
    end

Loading