| name | prepare-release |
| description | Prepare a release for the Azure App Configuration JavaScript Provider. Use when user mentions release preparation, version bump, creating merge PRs, preview release, or stable release for this project. |
Prepare Release
This skill automates the release preparation workflow for the Azure App Configuration JavaScript Provider project.
When to Use This Skill
Use this skill when you need to:
- Bump the package version for a new stable or preview release
- Create merge PRs to sync branches (main → preview, main → release/stable, preview → release)
- Prepare all the PRs needed before publishing a new release
- Resolve merge conflicts between main and preview branches
Background
Repository Information
Branch Structure
main – primary development branch for stable releasespreview – development branch for preview releasesrelease/stable/v{major} – release branch for stable versions (e.g., release/stable/v2)release/v{major} – release branch for preview versions (e.g., release/v2)
Version Files
The version must be updated in all four locations simultaneously:
src/version.ts – line 4: export const VERSION = "<version>";package.json – line 3: "version": "<version>",package-lock.json – line 3: "version": "<version>",package-lock.json – line 9: "version": "<version>",
Version Format
- Stable:
{major}.{minor}.{patch} (e.g., 2.4.0)
- Preview:
{major}.{minor}.{patch}-preview (e.g., 2.4.2-preview)
Quick Start
Ask the user whether this is a stable or preview release, and what the new version number should be. Then follow the appropriate workflow below.
Workflow A: Stable Release
Step 1: Version Bump PR
Create a version bump PR targeting main by running the version bump script:
./scripts/version-bump.sh <new_version>
For example: ./scripts/version-bump.sh 2.5.0
The script will automatically:
- Read the current version from
src/version.ts.
- Create a new branch from
main named <username>/version-<new_version> (e.g., linglingye/version-2.5.0).
- Update the version in all four files (
src/version.ts, package.json, package-lock.json lines 3 and 9).
- Commit, push, and create a PR to
main with title: Version bump <new_version>.
When the script prompts Proceed? [y/N], confirm by entering y.
Step 2: Merge Main to Release Branch
After the version bump PR is merged, create a PR to merge main into the stable release branch by running:
./scripts/merge-to-release.sh <new_version>
For example: ./scripts/merge-to-release.sh 2.5.0
When the script prompts Proceed? [y/N], confirm by entering y.
Important: Use "Merge commit" (not squash) when merging this PR to preserve commit history.
Workflow B: Preview Release
Step 1: Merge Main to Preview (Conflict Resolution)
Create a PR to merge main into preview. This will likely have conflicts.
- Fetch the latest
main and preview branches.
- Create a new branch from
preview named <username>/resolve-conflict (or similar).
- Merge
main into this branch. If there are conflicts, inform the user and let them resolve manually.
- Push the branch and create a PR targeting
preview with title: Merge main to preview.
Important: Use "Merge commit" (not squash) when merging this PR.
Sample PR: https://github.com/Azure/AppConfiguration-JavaScriptProvider/pull/272
Step 2: Version Bump PR
After the merge-to-preview PR is merged, create a version bump PR targeting preview by running the version bump script with the --preview flag:
./scripts/version-bump.sh <new_version> --preview
For example: ./scripts/version-bump.sh 2.5.1-preview --preview
When the script prompts Proceed? [y/N], confirm by entering y.
Step 3: Merge Preview to Release Branch
After the version bump PR is merged, create a PR to merge preview into the preview release branch by running:
./scripts/merge-to-release.sh <new_version> --preview
For example: ./scripts/merge-to-release.sh 2.5.1-preview --preview
When the script prompts Proceed? [y/N], confirm by entering y.
Important: Use "Merge commit" (not squash) when merging this PR.
Review Checklist
Each PR should be reviewed with the following checks:
