Skip to content

docs: Update copilot instructions to include release PR requirements#318

Merged
nev21 merged 3 commits into
mainfrom
copilot/update-copilot-instructions-release-details
May 11, 2026
Merged

docs: Update copilot instructions to include release PR requirements#318
nev21 merged 3 commits into
mainfrom
copilot/update-copilot-instructions-release-details

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 11, 2026

The copilot release instructions were missing several required steps, leaving gaps that could result in incomplete or inconsistently formatted releases.

Changes to .github/copilot-instructions.md

  • Commit message convention — All release commits must use [Release] Increase version to <version> as the subject line
  • README.md update step — Explicitly requires updating the recommended version range (for both core and chai shim) in README.md to match the new release version
  • Preserve unreleased CHANGELIST entries — New step that mandates existing unreleased entries in CHANGELIST.md be carried forward as-is into the new version section; must not be removed, reduced, or summarized
  • Step renumbering — Fixed duplicate step numbers in "Build and Test" introduced by the new commit step

Copilot AI changed the title [WIP] Update copilot instructions to include release details docs: Update copilot instructions to include release PR requirements May 11, 2026
Copilot AI requested a review from nev21 May 11, 2026 05:15
Copilot finished work on behalf of nev21 May 11, 2026 05:15
@nev21 nev21 marked this pull request as ready for review May 11, 2026 05:49
@nev21 nev21 requested review from a team as code owners May 11, 2026 05:49
Copilot AI review requested due to automatic review settings May 11, 2026 05:49
@nev21 nev21 enabled auto-merge (squash) May 11, 2026 05:49
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the repository’s Copilot release instructions to reduce missed steps and improve consistency when preparing release pull requests.

Changes:

  • Adds an explicit step to update the recommended dependency version range in README.md.
  • Adds guidance to preserve any existing “Unreleased” changelog entries when creating a new version section.
  • Adds a required release commit message format and renumbers the “Build and Test” steps accordingly.

Comment on lines +198 to +202
Update the recommended version range in `README.md` to reflect the new version:

```markdown
> ```json
> "@nevware21/tripwire": ">= 0.1.7 < 2.x"
Comment on lines +248 to +252
3. **Commit with the required message format**:
```bash
git commit -m "[Release] Increase version to 0.1.8"
```
All release commits **must** use the subject format `[Release] Increase version to <version>`.
@codecov
Copy link
Copy Markdown

codecov Bot commented May 11, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.30%. Comparing base (ed5fa70) to head (b22f20c).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #318   +/-   ##
=======================================
  Coverage   95.30%   95.30%           
=======================================
  Files         137      137           
  Lines        6388     6388           
  Branches     1679     1640   -39     
=======================================
  Hits         6088     6088           
  Misses        300      300           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Copy Markdown
Contributor

@nevware21-bot nevware21-bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved by nevware21-bot

@nev21 nev21 merged commit e9df56f into main May 11, 2026
14 checks passed
@nev21 nev21 deleted the copilot/update-copilot-instructions-release-details branch May 11, 2026 06:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Task] Update copilot instructions to include release details

4 participants