Skip to content

feat: GH action to remind developers to add release notes in CHANGELOG.md #57

Merged
cryptodev-2s merged 7 commits intomainfrom
cryptodev2s/changelog-checker
Apr 9, 2025
Merged

feat: GH action to remind developers to add release notes in CHANGELOG.md #57
cryptodev-2s merged 7 commits intomainfrom
cryptodev2s/changelog-checker

Conversation

@cryptodev-2s
Copy link
Copy Markdown
Contributor

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

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.

Usage examples:
Extension: MetaMask/metamask-extension#31706
Core (Monorepo): MetaMask/core#5575

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

@socket-security
Copy link
Copy Markdown

socket-security Bot commented Apr 8, 2025

@socket-security
Copy link
Copy Markdown

socket-security Bot commented Apr 8, 2025

👍 Dependency issues cleared. Learn more about Socket for GitHub ↗︎

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

Ignoring: npm/diff@5.2.0

View full report↗︎

Next steps

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of ecosystem/package-name@version specifiers. e.g. @SocketSecurity ignore npm/foo@1.0.0 or ignore all packages with @SocketSecurity ignore-all

@cryptodev-2s cryptodev-2s force-pushed the cryptodev2s/changelog-checker branch 5 times, most recently from e04ef80 to a0c48b8 Compare April 8, 2025 12:57
@cryptodev-2s cryptodev-2s changed the title Cryptodev2s/changelog checker feat: GH action to remind developers to add release notes in CHANGELOG.md Apr 8, 2025
@cryptodev-2s
Copy link
Copy Markdown
Contributor Author

@SocketSecurity ignore npm/diff@5.2.0

@cryptodev-2s cryptodev-2s force-pushed the cryptodev2s/changelog-checker branch 2 times, most recently from d9d7fba to 316ce39 Compare April 8, 2025 13:31
@cryptodev-2s cryptodev-2s force-pushed the cryptodev2s/changelog-checker branch from 316ce39 to 9449ec2 Compare April 8, 2025 13:33
@cryptodev-2s
Copy link
Copy Markdown
Contributor Author

cryptodev-2s commented Apr 8, 2025

@jake-perkins @Gudahtt @itsyoboieltr
I’ve created this PR based on the changes made by @jake-perkins in #54.
I made some adjustments to the flow to checkout the target repository before running the check, which avoids unnecessary GitHub API calls. I also adapted the flow to support monorepos, following a workflow consuming this shared worfklow Core.

] as const;

type RepositoryName = typeof REPOSITORY_NAMES[number];
type RepositoryName = (typeof REPOSITORY_NAMES)[number];
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.

It’s not related to the newly added workflow, but the lint workflow was failing.

Error:   18:23  error  Replace `typeof·REPOSITORY_NAMES` with `(typeof·REPOSITORY_NAMES)`  prettier/prettier

Comment thread .github/workflows/changelog-check.yml Outdated
Comment thread src/changelog-check.ts Outdated
Comment thread .github/workflows/changelog-check.yml Outdated
Comment thread .github/workflows/changelog-check.yml Outdated
Comment thread .github/workflows/changelog-check.yml Outdated
@jake-perkins
Copy link
Copy Markdown
Contributor

LGTM, i think the git cli is more intensive than the API calls for the changelog but it's not a big deal. As long as it works for your monorepo case and the client repositories it should be fine

@cryptodev-2s
Copy link
Copy Markdown
Contributor Author

Thanks @jake-perkins can I get a another review I just updated the ref to use main instead of the testing branch

@cryptodev-2s cryptodev-2s merged commit fd5f71c into main Apr 9, 2025
18 checks passed
@cryptodev-2s cryptodev-2s deleted the cryptodev2s/changelog-checker branch April 9, 2025 12:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants