Released Capsules

This guide introduces Released Capsules and Internal Releases, as well as how to create and use a Released Capsule.

A released capsule is an end-to-end reproducible version of your capsule that is separate from the original. This enables your team to use a fully functioning version while you develop your capsule.

Release capsules will inherit the sharing permissions of the original capsule. Once it has been created, the sharing permissions of the release capsule can be changed independently of the original. See Sharing Compute Capsules for more information.

Internal Releases are Released Capsules that have been shared with your organization. There is a dedicated dashboard for Internal Releases. See below for additional information.

Releasing a Compute Capsule

1. Click Release with the version in the top right corner of your capsule to release the capsule.
2. Complete the mandatory pre-release steps:

   2.1 Fill out the required metadata.

   2.2 Perform a reproducible run that includes all the latest changes.

   2.3 Ensure all files in your capsule are either tracked in Git or intentionally excluded from Git by adding them to the .gitignore file.

3. Once you meet all the criteria, the capsule is released. This creates a separate run-only version of your capsule that is available to anyone with access to the original. You can access the released version from the capsule Timeline.
4. If you continue to develop the original capsule and would like changes to be reflected in the released version, you can update the released capsule by clicking Release new version in the original capsule. All versions will be available in the released capsule’s Timeline. From any released version, users can easily toggle to others..

You can only release a capsule from the compute capsule IDE.

Only the Owner of the capsule can release the capsule.

Open Science Library

Gallery capsules have a dedicated dashboard that displays curated capsules.

Released capsules that have been shared with your entire organization will appear in the Open Science Library Dashboard. Navigate to this dashboard by clicking the Open Science Library icon on the left side bar from anywhere in Code Ocean.

The following steps indicate how to make your released capsule available in the Internal Releases Dashboard:

1. From the released capsule, click Share to set the permissions for the capsule.
2. Check Share with everyone.
3. Click Save.

Now this released capsule will be accessible to your entire organization through the Internal Releases Dashboard.

Find a Released Capsule

Navigate to the Capsules page () in the left sidebar. Select the Released tab to view the released capsules.

Internal releases are available on the Internal Releases Dashboard. A capsule shared with the entire organization will appear under both the Released tab and the Internal Releases Dashboard.

Working with a Released Capsule

From the Timeline, click Go To Released Capsule. The released status is indicated by a blue Released label in front of the capsule name. You can view any file of the released capsule and execute reproducible runs.

Execute a Reproducible Run in a Released Capsule

In the released capsule view, click Reproducible Run, at the top of the Timeline, to execute a run. A pop-up message appears to indicate the estimated re-run time. Click Proceed to continue.

If the released Capsule has the App Panel feature in use, click the App Panel tab to modify the parameters, then click Run with parameters. A pop-up message appears and indicates the estimated re-run time. Click Proceed to continue.

If the App Panel feature is in use, you can select the functionality that will be available in the released capsule. Refer to Metadata to see additional information about the Functionality Status.

Duplicate a Released Capsule

To edit a released capsule, you must duplicate it first.

1. Click Capsule in the menu.

2. Click Duplicate.

You are redirected to the newly duplicated capsule. The capsule name becomes Copy of + the original capsule name.

R Shiny for Release Capsules

R Shiny Cloud Workstation is accessible in Release Capsules. Capsules with R Shiny can be released as an app, accessible directly from the Internal Release page. The app can be accessed and run but users cannot make changes to the capsule.

To release a capsule as an R Shiny app, the owner/s of the original capsule can toggle R Shiny on via the Metadata page, prior to capsule release.

Note: If a release capsule has multiple versions, the Open R Shiny button represents the latest Release version from the Internal Release page.

The compute resource configuration of Release Capsules are versioned. The specific resource used is reflected and maintained when users switch between Capsule versions, this improves traceability and reproducibility.