docsector-reader: Command for GitHub Copilot

Release Docsector Reader

Steps

1. Review changes since last release

   • Run git log $(git describe --tags --abbrev=0)..HEAD --oneline to list all commits since the last tag.
   • Identify new features, fixes, and breaking changes.

2. Update bin/docsector.js VERSION constant

   • Update the VERSION constant (hardcoded at the top of the file) to match the new release version.

3. Validate the scaffold

   • Check if scaffold compiles successfully with the new version: npx docsector build
   • Run tests to ensure stability: npx vitest run

4. Update README.md

   • Add any new features to the ✨ Features section that were implemented since the last release.
   • Keep the existing style: emoji + bold title + dash + description.
   • Only update if necessary to reflect new features or changes in the release. Do not remove existing features from the README.

5. Bump version with npm version in the docsector-reader project root

   • For a patch release (bug fixes): npm version patch --no-git-tag-version
   • For a minor release (new features, no breaking changes): npm version minor --no-git-tag-version
   • For a major release (breaking changes): npm version major --no-git-tag-version

6. Commit, tag and push

   • Stage all changed files: git add -A
   • Commit with message: release: vX.Y.Z
   • Create a git tag: git tag vX.Y.Z
   • Push commits and tags: git push && git push --tags

7. Create GitHub Release

   • Language rule: the release title and body must be written in English.
   • Scope rule: release notes must describe only docsector-reader changes.
   • Include a ## Changes section and decorate bullet points with emojis.
   • Build release notes from README additions and recent commits.
   • Suggested notes template:

     > Focus: Short release summary in English.
     
     ## Changes
     - ✨ Added ...
     - 🛠️ Fixed ...
     - 📚 Updated docs ...
     - ✅ Validated ...
     

   • Create or update release using a notes file:

     gh release create vX.Y.Z --title "vX.Y.Z" --notes-file /tmp/docsector-release-vX.Y.Z.md
     

     gh release edit vX.Y.Z --title "vX.Y.Z" --notes-file /tmp/docsector-release-vX.Y.Z.md
     

   • Confirm release URL:

     gh release view vX.Y.Z --json url --jq .url
        ```