Add release process documentation to Copilot instructions#441
Merged
Conversation
Agent-Logs-Url: https://github.com/nevware21/grunt-plugins/sessions/e600a4db-274e-4d5d-8fac-3182a2e92354 Co-authored-by: nev21 <82737406+nev21@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add copilot instructions and update release files
Add release process documentation to Copilot instructions
May 11, 2026
nev21
approved these changes
May 11, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Adds release-process guidance to the repository’s Copilot instructions so automated agents (and contributors) have a documented checklist for version bumps, Rush shrinkwrap regeneration, and CHANGELOG updates across the monorepo.
Changes:
- Added a new “Release Process” section documenting the required PR/commit title format.
- Documented a release file checklist (package.json version bumps, shared-utils devDependency bumps, CHANGELOG + README updates, and regenerating
common/config/rush/npm-shrinkwrap.jsonvianpm run rupdate). - Documented CHANGELOG update rules, including the required “Full Release Details” link.
|
|
||
| (items added here after the release for the next version) | ||
|
|
||
| # vX.Y.Z (Month Dth, YYYY) |
Comment on lines
+224
to
+231
| ### Release Tags | ||
|
|
||
| GitHub releases are tagged separately for each publishable package: | ||
| - `ts-plugin-X.Y.Z` for `@nevware21/grunt-ts-plugin` (e.g., `ts-plugin-0.5.2`) | ||
| - `eslint-ts-X.Y.Z` for `@nevware21/grunt-eslint-ts` (e.g., `eslint-ts-0.5.2`) | ||
|
|
||
| The `[Full Release Details]` link added to each package CHANGELOG conventionally uses the `vX.Y.Z` format (e.g., `https://github.com/nevware21/grunt-plugins/releases/tag/v0.5.2`) as a shared reference for the version, even though the per-package GitHub release tags use the `ts-plugin-X.Y.Z` / `eslint-ts-X.Y.Z` naming scheme. | ||
|
|
nevware21-bot
approved these changes
May 11, 2026
Contributor
nevware21-bot
left a comment
nevware21-bot
left a comment
There was a problem hiding this comment.
Approved by nevware21-bot
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The repository lacked documented conventions for how releases are created, leaving Copilot agents without guidance on the required commit format, file checklist, and CHANGELOG rules.
Changes
.github/copilot-instructions.md— added a## Release Processsection covering:[Release] Increase version to X.Y.Z(required, no exceptions)package.jsonfiles (root, shared, ts-plugin, eslint-ts-plugin), bothCHANGELOG.mdfiles, rootREADME.md, andcommon/config/rush/npm-shrinkwrap.json(regenerated vianpm run rupdate)@nevware21/grunt-plugins-shared-utilsdevDependency ints-plugin/package.jsonandeslint-ts-plugin/package.jsonmust also be bumped to the new version# vX.Y.Z (Date)section with only significant changes; group minor dependency bumps into a single summary line[Full Release Details](https://github.com/nevware21/grunt-plugins/releases/tag/vX.Y.Z)# Unreleasedsection already has items, carry them into the new version section as-is — do not remove or summarize themts-plugin-X.Y.Z/eslint-ts-X.Y.Z; CHANGELOG links usevX.Y.Z@nevware21/grunt-ts-pluginand@nevware21/grunt-eslint-tsare published (sharedhasshouldPublish: false)