Auto-discover and verify new gov dependencie - #136
Conversation
… data and logic modules
6f0b9a5 to
4a6b414
Compare
decause-gov
left a comment
There was a problem hiding this comment.
There's a risk we'll hit API limits, but other than that, in the interest of completing this rotation before EoW, we're gonna merge and see what happens... that's what git is for ;)
natalialuzuriaga
left a comment
There was a problem hiding this comment.
Love the latest update with the new comment additions and documentation update, it makes this aspect of the tool a lot more easier to navigate and understand. After this last thing is address, should be good to merge!
|
|
||
| The `reusedCode` field is matched against a curated list of federal npm and PyPI packages in `src/gov-dependencies.data.ts`, each mapped to the agency and repository it comes from. | ||
|
|
||
| That list is kept current by an automated job under `src/gov-update/`. It crawls federal GitHub and npm organizations and verifies every package before adding it: the package's registry metadata must point at a repository in a known federal organization, and that repository must itself declare the package. Each addition goes through a pull request for a maintainer to review. |
There was a problem hiding this comment.
In this section could you specifically list the commands to run the job so it is straightforward for future devs? Also just wanted to verify if the job is automated? I don't see a workflow file / code of when the job is triggered to run and makes the PR with the data list update but I could've missed something.
There was a problem hiding this comment.
Just added, I wanted to keep it a seperate PR for adding the automated workflow to avoid crowding this PR, but in the interest of time it is probably best to just add it here.
natalialuzuriaga
left a comment
There was a problem hiding this comment.
Love the latest update with the new comment additions and documentation update, it makes this aspect of the tool a lot more easier to navigate and understand. After this last thing is address, should be good to merge!
Summary
Adds the tooling to keep
src/gov-dependencies.data.tsupdated on its own instead of by hand. Depends on #126, merge that first since this builds on its data and logic split.Changes
package.json,pyproject.toml, or READMEinstall command.
Notes
Part of issue: #124