Skip to content

changelog checker#54

Closed
jake-perkins wants to merge 42 commits intomainfrom
changelog-checker
Closed

changelog checker#54
jake-perkins wants to merge 42 commits intomainfrom
changelog-checker

Conversation

@jake-perkins
Copy link
Copy Markdown
Contributor

@jake-perkins jake-perkins commented Mar 13, 2025

This Change introduces a new shared workflow that will be confused by metamask-mobile and metamask-extension.
It will enforce that incoming PRs have either a modification to the Unreleased Section of the README or a label on the PR ( no-changelog ) which will indicate theres no external facing changes users need to know about

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

@socket-security
Copy link
Copy Markdown

socket-security Bot commented Mar 13, 2025

@socket-security
Copy link
Copy Markdown

socket-security Bot commented Mar 13, 2025

🚨 Potential security issues detected. Learn more about Socket for GitHub ↗︎

To accept the risk, merge this PR and you will not be notified again.

Alert Package NoteSourceCI
New author npm/diff@5.2.0 🚫
Deprecated npm/@types/axios@0.14.4
  • Reason: This is a stub types definition. axios provides its own type definitions, so you do not need this installed.
⚠︎

View full report↗︎

Next steps

What is new author?

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Scrutinize new collaborator additions to packages because they now have the ability to publish code into your dependency tree. Packages should avoid frequent or unnecessary additions or changes to publishing rights.

What is a deprecated package?

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Research the state of the package and determine if there are non-deprecated versions that can be used, or if it should be replaced with a new, supported solution.

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

  • @SocketSecurity ignore npm/diff@5.2.0
  • @SocketSecurity ignore npm/@types/axios@0.14.4

Comment thread src/changelog-check.ts Outdated
makemesteaks
makemesteaks previously approved these changes Mar 14, 2025
Comment thread src/changelog-check.ts
Comment thread .github/actionlint.yml
Comment thread src/changelog-check.ts Outdated
Comment thread src/changelog-check.ts Outdated
Comment thread src/changelog-check.ts Outdated
Comment thread src/changelog-check.ts Outdated

if (baseChanges === featureChanges) {
console.log(
"❌ No new entries detected under '## Unreleased'. Please update the changelog.",
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.

Two suggestions related to this:

  • This suggests that updating the changelog is the recommended way to address this error, but that's not necessarily true. We really don't want junk entries for non user-facing changes, that would make releases much more difficult rather than easier. We should be suggesting that the contributor either document user-facing changes, or add no-changelog to bypass the check if there are no user-facing changes.
  • Have you considered putting this in a comment rather than the console output? It will be much easier to see this feedback if it's in a comment, particularly as we first roll out this workflow.

Comment thread .github/workflows/changelog-check.yml Outdated
Comment thread .github/workflows/changelog-check.yml Outdated
Comment thread .github/workflows/changelog-check.yml
Comment thread .github/workflows/changelog-check.yml
Comment thread src/changelog-check.ts Outdated
Comment thread src/changelog-check.ts Outdated
Comment thread src/changelog-check.ts
Comment thread src/changelog-check.ts Outdated
Comment thread src/changelog-check.ts Outdated
Comment thread src/changelog-check.ts Outdated
jake-perkins and others added 2 commits March 24, 2025 15:39
Co-authored-by: Norbert Elter <72046715+itsyoboieltr@users.noreply.github.com>
Co-authored-by: Norbert Elter <72046715+itsyoboieltr@users.noreply.github.com>
@cryptodev-2s
Copy link
Copy Markdown
Contributor

@Gudahtt @itsyoboieltr I’ve opened a PR in Core for this same workflow action: MetaMask/core#5575.
I made sure to extract the shared workflow into a separate file so we can easily move it to github-tools later.
(cc @jake-perkins)

@jake-perkins
Copy link
Copy Markdown
Contributor Author

@Gudahtt @itsyoboieltr I’ve opened a PR in Core for this same workflow action: MetaMask/core#5575. I made sure to extract the shared workflow into a separate file so we can easily move it to github-tools later. (cc @jake-perkins)

I've made the code review updates and incorporated majority of the changes from your PR as it pertained to this one

@Gudahtt @cryptodev-2s @itsyoboieltr @sethkfman if you could review one more

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.

6 participants