feat: new attribution github workflow

[cryptodev-2s]

Description

This pull request introduces a GitHub Action workflow dedicated to managing attributions effectively within our project. The key components of this new workflow include:

• Local Scripts for Attributions Management:
  • yarn build:attribution: Updates attributions to reflect current dependencies.
  • yarn test:attribution-check: Checks if attributions are up-to-date with the latest changes.
• GitHub Actions:
  • A check to ensure attributions are up-to-date on all pull requests.
  • An action that allows team members to update attributions directly by commenting @metamskbot update-attributions on any PR.

Related issues

Fixes: #1550

Manual testing steps

Locally

• Run yarn build:attribution to update the attributions file.
• Run yarn test:attribution-check to ensure all attributions are current.

On GitHub (CI/PR)

• Open and push changes to a PR.
• Intentionally remove an entry from attribution.txt to simulate an error.
• Observe that CI fails due to missing attributions.
• Comment @metmaskbot update-attributions on the PR.
• A bot will respond with a thumbs up, followed by a comment indicating whether the attributions were successfully updated.

For a practical demonstration, refer to the pull request in my fork: PR Demonstration

Note

This functionality is currently operational only on a fork as it depends on the integration of the bot action into the develop branch.

Pre-merge author checklist

• I’ve followed MetaMask Coding Standards.
• I've completed the PR template to the best of my ability
• I’ve included tests if applicable
• I’ve documented my code using JSDoc format if applicable
• I’ve applied the right labels on the PR (see labeling guidelines). Not required for external contributors.

Pre-merge reviewer checklist

• I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
• I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

[github-actions]

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

[socket-security]

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/glob@10.4.1	Transitive: environment	+2	911 kB	isaacs
npm/minipass@7.1.2	None	0	286 kB	isaacs

🚮 Removed packages: npm/@lavamoat/allow-scripts@2.5.1

View full report↗︎

[socket-security]

🚨 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	Note	Source
New author	npm/validate-npm-package-name@5.0.1	New Author: npm-cli-ops Previous Author: lukekarrys	package.json
Network access	npm/agentkeepalive@4.5.0	Module: http Location: Package overview	Source
Network access	npm/agentkeepalive@4.5.0	Module: https Location: Package overview	Source
New author	npm/@npmcli/fs@2.1.2	New Author: gar Previous Author: lukekarrys	Source
Deprecated	npm/@npmcli/move-file@2.0.1	Reason: This functionality has been moved to @npmcli/fs	Source
Network access	npm/make-fetch-happen@10.2.1	Module: http-proxy-agent Location: Package overview	Source
Network access	npm/make-fetch-happen@10.2.1	Module: https-proxy-agent Location: Package overview	Source
Network access	npm/make-fetch-happen@10.2.1	Module: https Location: Package overview	Source
Network access	npm/make-fetch-happen@10.2.1	Module: http Location: Package overview	Source
New author	npm/unique-slug@3.0.0	New Author: lukekarrys Previous Author: zkat	Source
New author	npm/@lavamoat/aa@3.1.5	New Author: boneskull Previous Author: naugtur	Source
New author	npm/node-gyp@9.4.1	New Author: lukekarrys Previous Author: rvagg	Source
Shell access	npm/@lavamoat/allow-scripts@2.5.1	Module: child_process Location: Package overview	Source
New author	npm/@lavamoat/allow-scripts@2.5.1	New Author: boneskull Previous Author: naugtur	Source

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 network access?

This module accesses the network.

Packages should remove all network access that is functionally unnecessary. Consumers should audit network access to ensure legitimate use.

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.

What is shell access?

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Packages should avoid accessing the shell which can reduce portability, and make it easier for malicious shell access to be introduced.

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/validate-npm-package-name@5.0.1
• @SocketSecurity ignore npm/agentkeepalive@4.5.0
• @SocketSecurity ignore npm/@npmcli/fs@2.1.2
• @SocketSecurity ignore npm/@npmcli/move-file@2.0.1
• @SocketSecurity ignore npm/make-fetch-happen@10.2.1
• @SocketSecurity ignore npm/unique-slug@3.0.0
• @SocketSecurity ignore npm/@lavamoat/aa@3.1.5
• @SocketSecurity ignore npm/node-gyp@9.4.1
• @SocketSecurity ignore npm/@lavamoat/allow-scripts@2.5.1

[mcmire]

Makes sense to me, but I had one question.

[mcmire]

Looks good to me.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud