Working with releases in SourceCraft

A release is a fixed software product version that comprises a specific set of changes, a tag, a description, and additional resources, such as binaries or archives intended for users or other developers.

Releases offer convenient access to particular repository states for analysis and comparison, off-the-shelf builds for users, and give structure to the project development and versioning history.

Releases in SourceCraft are linked to a repository tag, an indicator of a significant milestone in the project's history. Only one release can be associated with one tag.

For more information, see Releases in SourceCraft.

Creating a release

Open the SourceCraft home page.
On the Home tab, under Your craftspace, navigate to Repositories and select your repository.
Under Code, navigate to Releases.
In the top-right corner, click New release.
Under General information:
1. Select the tag to create your new release from.
  
  Note
  
  You can only select a tag that was not used to create releases.
  
  You can use a pre-created tag or create a new one.
  
  To create a new tag:
  1. In the tag selection field, click .
  2. In the Tag field, enter a name for the tag.
  3. In the Target field, select the branch your new tag will be based on.
  4. Click Save.
2. Enter a name for your release.
Optionally, under Release notes:
- Select the previous release.
- Enter a description of the new release, e.g., specify what has been changed, fixed, or improved, and provide details about the update.
Optionally, under Release assets, click Add asset and select the resource type:
- File: Click Browse and upload a file from your local PC.
  
  Limitations
  
  SourceCraft has limits on the size of files you upload to a release.
- Link: Add a link to an external resource and enter its displayed name.
To add another resource, click Add asset.

To delete a resource, click next to it.
Click Publish release.

Tip

You can also save your release as a draft to modify it later instead of publishing it right away. To do this, click Save draft.

The description and contents of a draft release are available to users with the Repository admin or Repository maintainer roles.

Viewing a release

Open the SourceCraft home page.
On the Home tab, under Your craftspace, navigate to Repositories and select your repository.
Under Code, navigate to Releases.

The page will show a list of releases with their authors, publication dates and times, tags, commits, descriptions, and attached resources.

The list will also highlight the latest release.
Select the release you want to view.

Editing a release

Warning

You can edit only a draft release.

Open the SourceCraft home page.
On the Home tab, under Your craftspace, navigate to Repositories and select your repository.
Under Code, navigate to Releases.
Next to the draft release you want to update, click and select Edit.
Update the release settings and click Update release.

Canceling and deleting a release

Note

You cannot directly delete a published release; you need to cancel it first.

Open the SourceCraft home page.
On the Home tab, under Your craftspace, navigate to Repositories and select your repository.
Under Code, navigate to Releases.
Next to the release you want to cancel, click and select Discard release.

The description and contents of a canceled release remain available to users with the Repository admin or Repository maintainer roles.
To delete a release from the repository, click next to the release, select Delete, and confirm the deletion.

Comparing releases

Open the SourceCraft home page.
On the Home tab, under Your craftspace, navigate to Repositories and select your repository.
Under Code, navigate to Releases.
Next to the relevant release, click Compare and select the release to compare it with.

Was the article helpful?

Working with a milestone

Creating a tag