Skip to content

Commit

Permalink
Update README for input version of workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
RobjS committed Dec 3, 2021
1 parent 4f41a6c commit 25113bf
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,4 @@

This repo holds a reusable workflow for validating Dependabot files in GovPress projects.

It will search the repo for `composer.json` and `package.json` files, and then check there is an entry for each one in the repo's `dependabot.yml`. If there isn't, the workflow will fail.

This should ensure we don't allow our `dependabot.yml` files to fall out of date by not updating them when we add new `composer.json` or `package.json` files to a repo.
You can pass it any `package-ecosystem` (e.g. `composer`), and the corresponding filename for that package manager (e.g. `composer.json`). It will search the repo for any files matching that filename, and then check if the `dependabot.yml` file contains an entry for all found files for that package ecosystem. If it does not, the workflow will fail.

0 comments on commit 25113bf

Please sign in to comment.