From 23003f8f44e3cf509b4f86f7894b06323451e499 Mon Sep 17 00:00:00 2001 From: Nev Date: Sun, 8 Feb 2026 13:30:38 -0800 Subject: [PATCH 1/5] docs: Update copilot instructions --- .github/copilot-instructions.md | 78 ++++++++++++++++++++++++++++++--- 1 file changed, 73 insertions(+), 5 deletions(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 0039b75..120486f 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -168,11 +168,79 @@ expect(() => { doSomething(); }).to.not.throw(); 3. Run `npm install` at root 4. Test all environments to ensure compatibility -### Release Process -1. Run `npm run cleanBuild` - Full clean rebuild -2. Run `npm run npm-pack` - Create npm packages -3. Verify packages work correctly -4. Use `npm run npm-publish` for publishing +## Creating a Release PR + +### Prepare Release Branch + +1. **Work on current branch** - Make all changes on your current branch +2. **Do NOT commit changes** - Leave changes uncommitted so you can review them before creating the PR + +### Version Management + +#### Determine Version Number +Follow semantic versioning (semver) default release type is a patch unless requested otherwise: +- **Patch** (0.1.x → 0.1.y) +- **Minor** (0.x.0 → 0.y.0) +- **Major** (x.0.0 → y.0.0) + +#### Update Version Numbers +Update `version` field in all repo package.json files: +- `core/package.json` - Main tripwire package +- `shim/chai/package.json` - Chai shim package +- Root `package.json` - Monorepo version (should match core) + +### Update Changelog + +Edit `CHANGELIST.md` at the repository root: + +1. **Add version header** with date: + ```markdown + # v0.1.7 Month Day, Year + ``` + +2. **Organize significant changes by category** (only include meaningful changes): + - `## Breaking Changes` - Breaking API changes (if any) + - `## New Features` - New functionality added + - `## Bug Fixes` - Bug fixes and corrections + - `## Refactoring` - Code improvements without behavior changes + - `## Documentation & Maintenance` - Docs, dependencies, CI/CD changes + +3. **Link to PRs** for each significant change: + ```markdown + - [#123](https://github.com/nevware21/tripwire/pull/123) feat: Description + ``` + +4. **Add comparison link** at the end (this provides full details of every PR): + ```markdown + For full details see [v0.1.6...v0.1.7](https://github.com/nevware21/tripwire/compare/v0.1.6...v0.1.7) + ``` + + **Note**: Only include significant, meaningful changes in the categories above. The comparison link provides complete details of all PRs, so minor changes can be omitted from the summary. + +### Build and Test + +1. **Update npm shrinkwrap**: + ```bash + rush update --recheck + ``` + This updates the npm-shrinkwrap.json file to reflect current dependencies + +2. **Review all changes** - Verify version numbers, changelog, and shrinkwrap updates before committing + +3. **Clean build**: + ```bash + npm run cleanBuild + ``` + This runs: `git clean -xdf && npm install && grunt lint-fix && rush rebuild` + +4. **Run all tests**: + ```bash + npm run test + ``` + Runs tests in all three environments (node, browser, worker) + +5. **Verify build artifacts**: + - Check that referenced files, entry points and types in each of the package.json files are present (except for the root package.json which is not published and does not have entry points or types) ## CI/CD From 5dad737e59d87aba4b84d28476da622c26d29274 Mon Sep 17 00:00:00 2001 From: nev21 <82737406+nev21@users.noreply.github.com> Date: Sun, 8 Feb 2026 13:53:56 -0800 Subject: [PATCH 2/5] Update .github/copilot-instructions.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .github/copilot-instructions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 120486f..2cd4ba6 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -223,7 +223,7 @@ Edit `CHANGELIST.md` at the repository root: ```bash rush update --recheck ``` - This updates the npm-shrinkwrap.json file to reflect current dependencies + This updates the `common/config/rush/npm-shrinkwrap.json` file to reflect current dependencies 2. **Review all changes** - Verify version numbers, changelog, and shrinkwrap updates before committing From b5f418c027ebac2e95e1832e7a35fdc84596062d Mon Sep 17 00:00:00 2001 From: nev21 <82737406+nev21@users.noreply.github.com> Date: Sun, 8 Feb 2026 13:54:14 -0800 Subject: [PATCH 3/5] Update .github/copilot-instructions.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .github/copilot-instructions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 2cd4ba6..9dbe753 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -240,7 +240,7 @@ Edit `CHANGELIST.md` at the repository root: Runs tests in all three environments (node, browser, worker) 5. **Verify build artifacts**: - - Check that referenced files, entry points and types in each of the package.json files are present (except for the root package.json which is not published and does not have entry points or types) + - Check that referenced files, entry points and types in each of the package.json files are present (for published packages; the root package.json is not published, even though it defines entry points and types) ## CI/CD From 6b6b50e846ae4ef619574518595527a4645603e9 Mon Sep 17 00:00:00 2001 From: nev21 <82737406+nev21@users.noreply.github.com> Date: Sun, 8 Feb 2026 13:54:24 -0800 Subject: [PATCH 4/5] Update .github/copilot-instructions.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .github/copilot-instructions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 9dbe753..171c109 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -172,7 +172,7 @@ expect(() => { doSomething(); }).to.not.throw(); ### Prepare Release Branch -1. **Work on current branch** - Make all changes on your current branch +1. **Work on current branch** - Make all changes on your current branch 2. **Do NOT commit changes** - Leave changes uncommitted so you can review them before creating the PR ### Version Management From dd86d78132324a3708d72ca65889ff6b1fb5f3f9 Mon Sep 17 00:00:00 2001 From: nev21 <82737406+nev21@users.noreply.github.com> Date: Sun, 8 Feb 2026 13:54:55 -0800 Subject: [PATCH 5/5] Update .github/copilot-instructions.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .github/copilot-instructions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 171c109..61f55b8 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -178,7 +178,7 @@ expect(() => { doSomething(); }).to.not.throw(); ### Version Management #### Determine Version Number -Follow semantic versioning (semver) default release type is a patch unless requested otherwise: +Follow semantic versioning (semver). The default release type is a patch unless requested otherwise: - **Patch** (0.1.x → 0.1.y) - **Minor** (0.x.0 → 0.y.0) - **Major** (x.0.0 → y.0.0)