Skip to main content

Generating A New Release

Standard Release Procedure​

caution

Please note, this documentation applies solely to version 2.16.0 and subsequent versions. It's incompatible with prior versions.

When to Initiate​

A standard release procedure is initiated against the main branch, accomplishing several tasks:

  1. It increments the Minor Version of the package (Major.Minor.Patch), creates a tag, and creates the corresponding hotfix/v<major>.<minor> branch from that tag. This process also generates a change log detailing the variations from the previous release.
  2. It creates NPM packages and forwards these packages to the production package repository.
  3. It constructs both VSCode Extensions: Logic Apps Standard and Logic Apps Data Mapper.
  4. It prepares a GitHub release inclusive of a change log and all artifacts intended for submission.

You should execute this procedure in preparation for a routine release cycle.

Execution Steps​

  1. Navigate to https://github.com/Azure/LogicAppsUX/actions/workflows/version-release.yml.
  2. Select 'Run Workflow', ensuring that the branch is set to 'main' and the release type is designated as 'Minor', as depicted below. Production Release Settings
  3. Initiate 'Run Workflow'.
  4. Completion.

Hotfix Release Procedure​

When to Initiate​

A hotfix release procedure is initiated against a hotfix branch for a specific minor version. This is particularly handy when an immediate fix is required, but you prefer not to incorporate every change from the main branch.

This process will:

  1. Increment the Patch Version of the package, specific to the minor version. For instance, executing the process on minor version 2.32.0 will yield 2.32.1. A subsequent hotfix would produce 2.32.2. This process remains exclusive to the hotfix branch.
  2. Create NPM packages and dispatch them to the production package repository.
  3. Construct both VSCode Extensions: Logic Apps Standard and Logic Apps Data Mapper.
  4. Prepare a GitHub release inclusive of a change log and all necessary artifacts for submission.

Execution Steps​

note

The assumption here is that the necessary change has already been committed to the main branch. Only under rare circumstances should a change first be made in the hotfix branch.

  1. Locate the hotfix/v<major>.<minor> branch created automatically when the corresponding v<major>.<minor>.0 release was published.

  2. If the hotfix branch predates this automation and does not exist, create it from the patch-zero tag and push it to the main repository. Write permission is required for this fallback. Example command (replace 'version' with your version):

git checkout -b hotfix/v2.17 v2.17.0
git push origin hotfix/v2.17
note

The tag version that the branch is created from should always be patch version 0. To achieve anything higher than 0, the hotfix branch must have been previously created.

  1. Cherry pick the required change to your hotfix branch, ensuring there are no merge conflicts.
git cherry-pick <commit-id>
  1. Push the updated branch to the main repository.
git push

  1. Navigate to https://github.com/Azure/LogicAppsUX/actions/workflows/version-release.yml.

  2. Select 'Run Workflow', ensuring that the branch is set to your hotfix branch and the release type is 'Patch', as shown below. Hotfix Release Settings

  3. Initiate 'Run Workflow'.

  4. Completion.