Skip to content

chore: GH action to remind developers to add release notes in CHANGELOG.md#5575

Closed
cryptodev-2s wants to merge 32 commits intomainfrom
changelog-checker
Closed

chore: GH action to remind developers to add release notes in CHANGELOG.md#5575
cryptodev-2s wants to merge 32 commits intomainfrom
changelog-checker

Conversation

@cryptodev-2s
Copy link
Copy Markdown
Contributor

@cryptodev-2s cryptodev-2s commented Apr 1, 2025

Explanation

This PR introduces a new CI workflow that enforces the inclusion of a CHANGELOG entry for any changes made by developers. It supports both single-package repositories and monorepos using Yarn workspaces.

The shared workflow has been structured for easy migration to the github-tools repository in the future.

Testing flow:

  1. The first commit runs the workflow and passes, as it doesn’t introduce any changes that require a changelog update.
  2. The second commit adds a dummy change to the ens-controller package, triggering the requirement for a changelog entry in ens-controller/CHANGELOG.md.
  3. The third commit fixes the pipeline by adding the missing changelog entry for the ens-controller package.
  4. The fourth commit introduces dummy changes in two packages — accounts-controller and address-book-controller — both of which require corresponding changelog entries.
  5. The fifth commit resolves the pipeline by adding the necessary changelog entries for both accounts-controller and address-book-controller.

Fixes: https://github.com/MetaMask/MetaMask-planning/issues/3678

References

Changelog

Checklist

  • I've updated the test suite for new or updated code as appropriate
  • I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • I've communicated my changes to consumers by updating changelogs for packages I've changed, highlighting breaking changes as necessary
  • I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

@cryptodev-2s cryptodev-2s added the team-wallet-framework Deprecated: Please use `team-core-platform` instead. label Apr 1, 2025
@cryptodev-2s cryptodev-2s self-assigned this Apr 1, 2025
@cryptodev-2s cryptodev-2s requested a review from a team as a code owner April 1, 2025 14:58
@cryptodev-2s cryptodev-2s changed the title chore: CI step to require devs to add a CHANGELOG entry for new changes chore: GH action to reminder developers to add release notes in CHANGELOG.md Apr 1, 2025
@cryptodev-2s cryptodev-2s marked this pull request as draft April 1, 2025 15:01
@cryptodev-2s cryptodev-2s force-pushed the changelog-checker branch 2 times, most recently from bdc6f9e to bb9d0bd Compare April 1, 2025 18:39
@cryptodev-2s cryptodev-2s changed the title chore: GH action to reminder developers to add release notes in CHANGELOG.md chore: GH action to remind developers to add release notes in CHANGELOG.md Apr 1, 2025
@cryptodev-2s cryptodev-2s force-pushed the changelog-checker branch 2 times, most recently from 3e19b80 to 0c5b244 Compare April 1, 2025 19:26
@cryptodev-2s cryptodev-2s marked this pull request as ready for review April 1, 2025 19:28
Comment thread scripts/changelog-check.ts Outdated
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This file is intended to be moved to the github-tools repository later.

Comment thread package.json Outdated
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This script is intended to be moved to the github-tools repository later.

@cryptodev-2s cryptodev-2s requested a review from a team as a code owner April 1, 2025 19:37
@cryptodev-2s cryptodev-2s linked an issue Apr 2, 2025 that may be closed by this pull request
@cryptodev-2s cryptodev-2s requested a review from a team as a code owner April 2, 2025 12:08
@@ -1 +1,2 @@
export * from './EnsController';
export type TestType = 'test';
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Dummy change that should trigger the workflow

Comment thread scripts/changelog-check.ts Outdated
@cryptodev-2s cryptodev-2s requested a review from a team as a code owner April 2, 2025 12:44
@cryptodev-2s cryptodev-2s requested a review from mcmire April 4, 2025 21:51
Comment thread .github/workflows/changelog-check.yml Outdated
@mcmire
Copy link
Copy Markdown
Contributor

mcmire commented Apr 16, 2025

@cryptodev-2s Can this PR be closed now? It seems to have been superseded by #5620.

@cryptodev-2s
Copy link
Copy Markdown
Contributor Author

cryptodev-2s commented Apr 16, 2025

closed as superseded by #5620.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

team-wallet-framework Deprecated: Please use `team-core-platform` instead.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants