Create changetool script for validating change-notes - #4113
Open
mario-campos wants to merge 8 commits into
Open
Conversation
mario-campos
force-pushed
the
mario-campos/add-changenote-script
branch
from
August 26, 2026 22:13
eb65ce0 to
426c104
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a standalone TypeScript CLI for validating change-note files.
Changes:
- Validates filenames, categories, and Markdown structure.
- Adds unit tests and package configuration.
- Integrates changetool testing and linting into CI.
Show a summary per file
| File | Description |
|---|---|
scripts/changetool/index.ts |
Implements CLI dispatch and exit codes. |
scripts/changetool/cli/validate.ts |
Implements change-note validation. |
scripts/changetool/cli/validate.test.ts |
Tests validation behavior. |
scripts/changetool/package.json |
Defines scripts and dependencies. |
scripts/changetool/package-lock.json |
Locks package dependencies. |
scripts/changetool/tsconfig.json |
Configures TypeScript compilation. |
eslint.config.mjs |
Adds changetool lint configuration. |
.github/workflows/pr-checks.yml |
Adds a dedicated test job. |
Review details
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Files not reviewed (1)
- scripts/changetool/package-lock.json: Generated file
- Files reviewed: 7/8 changed files
- Comments generated: 7
- Review effort level: Balanced
`.every()` short-circuits on the first `false`
Apparently, the `in` operator will check inherited properties too.
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.
This PR introduces a distinct NPM package/script under
scripts/changetoolfor the purpose of validating change-notes (and eventually, in a subsequent PR, merging change-notes into CHANGELOG.md).Presently, this script has only one command,
validate(executed asnpm --prefix scripts/changetool start validate), which accepts path(s) to change-note files to be validated. Any flaws in the change-notes are described in the output, and the command will exit with 1.Risk assessment
For internal use only. Please select the risk level of this change:
Which use cases does this change impact?
Workflow types:
Products:
Environments:
How did/will you validate this change?
.test.tsfiles).If something goes wrong after this change is released, what are the mitigation and rollback strategies?
How will you know if something goes wrong after this change is released?
Are there any special considerations for merging or releasing this change?
Merge / deployment checklist