Merge pull request #309 from Azure/main

Merge main into release/stable/v2 for v2.4.1 stable release

Author: linglingye001

.github/skills/prepare-release/SKILL.md

@@ -0,0 +1,133 @@
+---
+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](https://github.com/Azure/AppConfiguration-JavaScriptProvider) 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
+- **GitHub Repo**: https://github.com/Azure/AppConfiguration-JavaScriptProvider
+- **Package Name**: `@azure/app-configuration-provider`
+
+### Branch Structure
+- `main` – primary development branch for stable releases
+- `preview` – development branch for preview releases
+- `release/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:
+1. `src/version.ts` – line 4: `export const VERSION = "<version>";`
+2. `package.json` – line 3: `"version": "<version>",`
+3. `package-lock.json` – line 3: `"version": "<version>",`
+4. `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.1-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:
+
+```bash
+./scripts/version-bump.sh <new_version>
+```
+
+For example: `./scripts/version-bump.sh 2.5.0`
+
+The script will automatically:
+1. Read the current version from `src/version.ts`.
+2. Create a new branch from `main` named `<username>/version-<new_version>` (e.g., `linglingye/version-2.5.0`).
+3. Update the version in all four files (`src/version.ts`, `package.json`, `package-lock.json` lines 3 and 9).
+4. 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:
+
+```bash
+./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.
+
+1. Fetch the latest `main` and `preview` branches.
+2. Create a new branch from `preview` named `<username>/resolve-conflict` (or similar).
+3. Merge `main` into this branch. If there are conflicts, inform the user and let them resolve manually.
+4. 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:
+
+```bash
+./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:
+
+```bash
+./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:
+- [ ] Version is updated consistently across all 3 files
+- [ ] No unintended file changes are included
+- [ ] Merge PRs use **merge commit** strategy (not squash)
+- [ ] Branch names follow the naming conventions
+- [ ] All CI checks pass

.gitignore

@@ -410,4 +410,4 @@ types/
 *.tgz
 
 # examples
-examples/package-lock.json
+examples/*/package-lock.json

examples/console-app/README.md

@@ -31,6 +31,8 @@ To run the examples using the published version of the package:
     npm install
     ```
 
+    This will install all required packages listed in `package.json` with their latest compatible versions.
+
 2. There are two ways to run the examples using correct credentials:
 
     - Edit the file `.env.template`, adding the access keys to your App Configuration store. and rename the file from `.env.template` to just `.env`. The examples will read this file automatically.