Creating and Using Release Capsules

A release Capsule is a permanently reproducible, run-only version, that is separate from the original. This enables your team to use a fully functioning version while you develop on the original.

The release Capsule will inherit the sharing permissions of the original. Once it has been created, the sharing permissions of the release can be changed independently of the original.

Releasing a Compute Capsule

1. Click Release in the top right corner of your Capsule to begin the release process.

   
2. Complete the mandatory pre-release steps:

   • Fill out the required metadata.

   • Perform a Reproducible Run that includes all the latest changes.

   • 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've completed all the criteria, the Capsule can be 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 release version from the Capsule Timeline.

   
4. If you continue to develop the original Capsule and would like changes to be reflected in the release version, you can update the release Capsule by clicking Release a new version in the original Capsule. All versions will be available in the release Capsule’s Timeline as well as through a dropdown menu above the Timeline. From any release version, users can easily toggle to others.

Only Owners of the Capsule or Pipeline can release it.

No-Code Apps

Capsules that are used as No-Code Apps have an additional field to complete in the metadata page: the type of No-Code App must be selected.

In the pre-release page, No-Code App options will be available for release depending on the Capsule's history. The options are:

1. App Panel, if a valid App Panel has been created.

2. Shiny, if the Shiny Cloud Workstation has been used.

3. Streamlit, if the Streamlit Cloud Workstation has been used.

4. Ubuntu, if the Ubuntu Cloud Workstation has been used.

5. IGV, if the IGV Cloud Workstation has been used.

This will ensure the appropriate Cloud Workstation is available in the release Capsule. These Apps can be launched directly from the Releases dashboard by clicking the "Open No-Code App" link of the corresponding Capsule.

Find a Release Capsule

Navigate to the My Capsules dashboard () in the left sidebar. Select the Released tab to view any release Capsule you have access to.

Working with a Release Capsule

From the original Capsule, navigate to the release Capsule by clicking Go To Release Capsule in the Timeline. The Capsule's release status is indicated by a blue Release label to the left of the Capsule's title.

In the release Capsule you can explore any files the author made available, execute Reproducible Runs, create Data Assets from results, and duplicate the release version.

In the release Capsule, click Reproducible Run to execute a run. A pop-up message appears to indicate the estimated re-run time. Click Proceed to continue.

Any user with access to the release Capsule can do a Reproducible Run, but in the Timeline each user will only see the Release Results and results from runs they started.

To edit a release version, 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.