feat: Implement New Attributions Update Workflow via GitHub Actions

cryptodev-2s commented 1 week ago

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 Attribution Management:
- yarn generate:attributions: Updates attributions to reflect current dependencies.
- yarn test:attributions-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: #1947

Manual testing steps

Locally

Run yarn generate:attributions to update the attributions file.
Execute yarn test:attributions-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 @metmask 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.

Screenshots/Recordings

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[bot] commented 1 week ago

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[bot] commented 1 week ago

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

Package	New capabilities	Transitives	Size	Publisher
npm/@metamask/license-checker@26.0.1	filesystem	`0`	106 kB	lgbot
npm/@metamask/oss-attribution-generator@2.0.2	filesystem	`0`	13.6 kB	lgbot
npm/@metamask/spdx-compare@2.0.0	None	`0`	4 kB	lgbot
npm/@metamask/spdx-satisfies@6.0.0	None	`0`	8.57 kB	lgbot
npm/aproba@2.0.0	None	`0`	8.05 kB	iarna
npm/deep-is@0.1.4	None	`0`	8.11 kB	thlorenz
npm/fs-jetpack@5.1.0	filesystem	`0`	132 kB	szwacz
npm/metamask-extension-generate-attributions@0.0.0-use.local	None	`0`	0 B
npm/nopt@6.0.0	environment	`+1`	28.7 kB	gar
npm/npmlog@6.0.2	None	`0`	17.1 kB	lukekarrys
npm/ramda@0.18.0	None	`0`	595 kB	davidchambers
npm/spdx-ranges@2.1.1	None	`0`	5.85 kB	kemitchell
npm/taim@1.1.0	None	`0`	8.05 kB	rane
npm/treeify@1.1.0	None	`0`	22.2 kB	notatestuser

🚮 Removed packages: npm/@babel/plugin-proposal-class-properties@7.18.6, npm/@babel/plugin-proposal-nullish-coalescing-operator@7.18.6, npm/@babel/plugin-proposal-optional-chaining@7.21.0, npm/@sinonjs/formatio@5.0.1, npm/@storybook/store@7.4.6, npm/@types/glob@7.2.0, npm/aproba@1.2.0, npm/babel-plugin-named-exports-order@0.0.2, npm/babel-plugin-react-docgen@4.2.1, npm/bluebird@3.7.2, npm/c8@7.14.0, npm/character-entities-html4@1.1.3, npm/collapse-white-space@1.0.5, npm/consolidate@0.16.0, npm/date-now@0.1.4, npm/detect-libc@1.0.3, npm/error-inject@1.0.0, npm/estree-to-babel@3.2.1, npm/generic-names@2.0.1, npm/hash-sum@2.0.0, npm/icss-replace-symbols@1.1.0, npm/ignore-walk@3.0.1, npm/is-alphanumeric@1.0.0, npm/is-whitespace-character@1.0.3, npm/is-word-character@1.0.3, npm/markdown-escapes@1.0.3, npm/mdast-util-compact@2.0.1, npm/merge-source-map@1.1.0, npm/needle@2.4.0, npm/node-pre-gyp@0.12.0, npm/npm-bundled@1.1.2, npm/npm-packlist@1.4.8, npm/npmlog@4.1.2, npm/os-tmpdir@1.0.2, npm/osenv@0.1.5, npm/postcss-modules@4.1.3, npm/query-ast@1.0.4, npm/react-resize-detector@7.1.2, npm/read-package-json-fast@3.0.2, npm/sass@1.69.7, npm/sax@1.3.0, npm/scss-parser@1.0.5, npm/simple-update-notifier@2.0.0, npm/sourcemap-codec@1.4.8, npm/state-toggle@1.0.2, npm/string-hash@1.1.3, npm/stringify-entities@3.0.1, npm/trim-trailing-lines@1.1.2, npm/trim@0.0.3, npm/unherit@1.1.2, npm/unist-util-remove-position@2.0.1, npm/vfile-location@3.2.0

View full report↗︎

cryptodev-2s commented 1 week ago

@metamaskbot update-attributions

socket-security[bot] commented 1 week ago

🚨 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
New author	npm/nopt@6.0.0	New Author: gar Previous Author: isaacs
New author	npm/npmlog@6.0.2	New Author: lukekarrys Previous Author: gar

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.

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/nopt@6.0.0
@SocketSecurity ignore npm/npmlog@6.0.2

cryptodev-2s commented 1 week ago

@metamaskbot update-attributions

cryptodev-2s commented 1 week ago

@metamaskbot update-attributions

cryptodev-2s commented 1 week ago

@metamaskbot update-policies

metamaskbot commented 1 week ago

Policies updated

cryptodev-2s commented 1 week ago

@metamaskbot update-policies

metamaskbot commented 1 week ago

Policies updated

cryptodev-2s commented 1 week ago

@metamaskbot update-attributions

cryptodev-2s commented 1 week ago

Currently Lint rule runs on every PR(create, update) once this PR is approved. I will switch the github action to run only on release branches.

MetaMask / metamask-extension