Skip to content

RELEASE.md

Latest commit

 

History

History
56 lines (36 loc) · 2.01 KB

RELEASE.md

File metadata and controls

56 lines (36 loc) · 2.01 KB

Release

This document outlines the process for creating a new release for Directory packages. All code block examples provided below correspond to an update to version v1.0.0, please update accordingly.

1. Create Release branch

Prepare a new release for the desired version by running the following command:

task release:create RELEASE_VERSION=v1.0.0

Note

For SDK release candidates, versions like 1.0.0-rc.1 becomes 1.0.0-rc.1 in JavaScript package.json and 1.0.0rc1 in Python pyproject.toml.

2. Create and Push Tags

  • After the pull request is approved and merged, update your local main branch.
git checkout main
git pull origin main
  • To trigger the release workflow, create and push to the repository a release tag for the last commit.
git tag -a v1.0.0
git push origin v1.0.0

Please note that the release tag is not necessarily associated with the "release: prepare version v1.0.0" commit. For example, if any bug fixes were required after this commit, they can be merged and included in the release.

3. Publish SDK packages (Manual)

SDK packages (JavaScript and Python) are not automatically published during the release workflow. Before publishing the GitHub release, you must manually trigger the SDK release workflow.

  1. Navigate to Actions > Release SDK

  2. Click Run workflow

  3. In the Use workflow from dropdown, select the release tag (e.g., v1.0.0)

  4. Select the options:

    • Make a javascript SDK release: Check to publish to npm
    • Make a python SDK release: Check to publish to PyPI

  5. Click Run workflow to start the release

4. Publish release

  • Wait until the release workflow is completed successfully.

  • Navigate to the Releases page and verify the draft release description as well as the assets listed.

  • Once the draft release has been verified, click on Edit release and then on Publish Release.