Skip to content

Validate change-notes as a PR check - #4116

Open
mario-campos wants to merge 5 commits into
mainfrom
mario-campos/validate-cn-workflow
Open

mario-campos wants to merge 5 commits into
mainfrom
mario-campos/validate-cn-workflow

Conversation

@mario-campos

@mario-campos mario-campos commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

This PR extends the behavior of the recently added pr-checks/changenotes.mts tool by:

  1. Hardcoding the argument as the newly-added unreleased-change-notes directory, as that is the only destination for change-notes.
  2. Adding a step in the pr-checks.yml workflow file for executing pr-checks/changenotes.mts in PRs to validate any changenotes in unreleased-change-notes.

This PR also introduces an "empty" top-level directory, unreleased-change-notes, to be the destination of future change-note files. This can be changed if another location is more suitable.

Risk assessment

For internal use only. Please select the risk level of this change:

  • Low risk: Changes are fully under feature flags, or have been fully tested and validated in pre-production environments and are highly observable, or are documentation or test only.

Which use cases does this change impact?

Workflow types:

  • N/A

Products:

  • N/A

Environments:

  • Testing/None - This change does not impact any CodeQL workflows in production.

How did/will you validate this change?

  • Unit tests - I am depending on unit test coverage (i.e. tests in .test.ts files).

If something goes wrong after this change is released, what are the mitigation and rollback strategies?

  • Development/testing only - This change cannot cause any failures in production.

How will you know if something goes wrong after this change is released?

  • N/A

Are there any special considerations for merging or releasing this change?

  • No special considerations - This change can be merged at any time.

Merge / deployment checklist

  • Confirm this change is backwards compatible with existing workflows.
  • Consider adding a changelog entry for this change.
  • Confirm the readme and docs have been updated if necessary.

@mario-campos
mario-campos requested a review from a team as a code owner August 31, 2026 16:50
Copilot AI balanced review requested due to automatic review settings August 31, 2026 16:50
@github-actions github-actions Bot added the size/M Should be of average difficulty to review label Aug 31, 2026

This comment was marked as outdated.

This comment was marked as outdated.

@github github deleted a comment from connected79844 Sep 1, 2026
mbg

This comment was marked as outdated.

@mario-campos

Copy link
Copy Markdown
Contributor Author

Closing this to re-work these changes after a migration to the pr-checks directory. Changes will be pushed to a new PR.

@mario-campos mario-campos reopened this Sep 11, 2026
@mario-campos
mario-campos marked this pull request as draft September 11, 2026 02:58
@mario-campos
mario-campos force-pushed the mario-campos/validate-cn-workflow branch from f2789ac to ef0cd9e Compare September 11, 2026 03:07

@mbg mbg left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Appreciate that this is a draft pending the changes in the other PRs, but some drive-by comments since I saw this and you could look at incorporating the feedback when updating this PR once the others are merged.

Comment thread .github/workflows/pr-checks.yml Outdated
Comment thread eslint.config.mjs
Comment thread pr-checks/changelog/validate.mts Outdated
@mario-campos
mario-campos force-pushed the mario-campos/validate-cn-workflow branch from 17bb097 to b652468 Compare September 11, 2026 19:35
@github-actions github-actions Bot added size/S Should be easy to review and removed size/M Should be of average difficulty to review labels Sep 11, 2026
@mario-campos
mario-campos force-pushed the mario-campos/validate-cn-workflow branch from b652468 to 21b6978 Compare September 11, 2026 19:52
@github-actions github-actions Bot added size/M Should be of average difficulty to review and removed size/S Should be easy to review labels Sep 11, 2026
@mario-campos
mario-campos force-pushed the mario-campos/validate-cn-workflow branch 2 times, most recently from 425de06 to c4bd5c9 Compare September 11, 2026 21:00
This commit also introduces the 'empty' home directory for future change-notes.
@mario-campos
mario-campos force-pushed the mario-campos/validate-cn-workflow branch from c4bd5c9 to f60f4d9 Compare September 11, 2026 21:04
@github-actions github-actions Bot added the size/S Should be easy to review label Sep 11, 2026
@github-actions github-actions Bot removed the size/M Should be of average difficulty to review label Sep 11, 2026
@mario-campos
mario-campos marked this pull request as ready for review September 11, 2026 21:06
@mario-campos
mario-campos requested a review from mbg September 14, 2026 16:11
mbg
mbg previously approved these changes Sep 14, 2026

@mbg mbg left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This LGTM, with two non-blocking suggestions for improvements.

Comment thread pr-checks/changelog/validate.test.mts Outdated
Comment thread pr-checks/changenotes.mts Outdated
Also, slightly improve the log statement of the validation error case.
…oteFiles`

The `isValidAllChangenoteFiles` now accepts a list of file paths rather than a file path string.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/S Should be easy to review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants