Skip to content

RELEASE.md

Latest commit

 

History

History
56 lines (33 loc) · 2.08 KB

RELEASE.md

File metadata and controls

56 lines (33 loc) · 2.08 KB

Arazzo Engine release instructions

Arazzo Engine is a monorepo containing multiple packages. Each package has its own release lifecycle and versioning. Arazzo Engine Release GitHub Action Workflow is used to release individual packages and associated release artifacts.

Release process

Follow the below steps to release a new version of the Arazzo Engine package.

1. Visit Arazzo Engine repo Actions tab

From the left side menu, click on Arazzo Engine Release.

image

2. Configure the workflow run

Click on Run workflow button inside the blue banner. Popup with workflow inputs will appear, and inputs are pre-filled with default values. Pick the main branch (main is the primary release branch). Pick the component and the version bump type.

Version bump types:

Major bump: '1.0.0' -> '2.0.0'
Minor bump: '1.0.0' -> '1.1.0'
Patch bump: '1.0.0' -> '1.0.1'

Blue banner

image

Configuration

image

3. Run the workflow

Click on Run workflow button. This will trigger the release process for selected component. This includes creating a release commit, release tag, and draft GitHub release along with publishing all the release artifacts to different registries.

4. Publish the Draft GitHub release

Visit the Arazzo Engine Releases. Click on the newest draft release that was autogenerated from the release tag.

  • edit its description as needed
  • set previous tag if not set

Once done, click on Publish release button. You're all set now.