Hi there! We're thrilled that you'd like to contribute to this project.
Contributions to this project are released to the public under the project's open source license.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
If you've encountered a problem, please let us know by submitting an issue!
If you've got an idea for a new feature or a significant change to the code or its dependencies, please submit as an issue so that the community can see it, and we can discuss it there. We may not be able to respond to every single issue, but will make a best effort!
If you'd like to make a contribution yourself, we ask that before significant effort is put into code changes, that we have agreement that the change aligns with our strategy for the action. Since this is a verified Action owned by GitHub we want to make sure that contributions are high quality, and that they maintain consistency with the rest of the action's behavior.
- Create an issue discussing the idea, so that we can discuss it there.
- If we agree to incorporate the idea into the action, please write-up a high level summary of the approach that you plan to take so we can review
We have begun using a Stalebot action to help keep the Issues and Pull requests backlogs tidy. You can see the configuration. If you'd like to keep an issue open after getting a stalebot warning, simply comment on it and it'll reset the clock.
Ready to contribute to dependency-review-action? Here is some information to help you get started.
This action makes an authenticated query to the Dependency Review API endpoint (GET /repos/{owner}/{repo}/dependency-graph/compare/{basehead}) to find out the set of added and removed dependencies for each manifest.
The action then evaluates the differences between the pushes based on the rules defined in the action configuration, and summarizes the differences and any violations of the rules you have defined as a comment in the pull request that triggered it and the action outputs.
Before you begin, you need to have Node.js installed, minimum version 20.
- Fork and clone the repository
- Change to the working directory:
cd dependency-review-action - Install the dependencies:
npm install - Make sure the tests pass on your machine:
npm run test
We have a script to scan a given PR for vulnerabilities, which will help you test your local changes. Make sure to grab a Personal Access Token (PAT) before proceeding (you'll need repo permissions for private repos):
The syntax of the script is:
$ GITHUB_TOKEN=<token> ./scripts/scan_pr <pr_url>Like this:
$ GITHUB_TOKEN=<token> ./scripts/scan_pr https://github.com/actions/dependency-review-action/pull/3Configuration options can be set by
passing an external YAML configuration file to the
scan_pr script with the -c/--config-file option:
$ GITHUB_TOKEN=<token> ./scripts/scan_pr --config-file my_custom_config.yml <pr_url>npm run test
Note: We don't have a very comprehensive test suite, so any contributions to the existing tests are welcome!
- Create a new branch:
git checkout -b my-branch-name - Make your change, add tests, and make sure the tests still pass
- Push to your fork and submit a pull request
(note: we don't recommend including changes to the dist directory in your pull request, because changes there have an increased likelihood of conflicts.)
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
- Add unit tests for new features.
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
- Write a good commit message.
- Add examples of the usage to examples.md
- Link to a sample PR in a custom repository running your version of the Action.
- Please be responsive to any questions and feedback that you get from a maintainer of the repo!
Details
Note: these instructions are for maintainers
- Create a local branch based on the
mainof the upstream repo. - Update the version number in package.json and run
npm ito update the lockfile. - Update the dist files by running
npm run buildandnpm run package - Submit a PR based on your branch and have another maintainer review/approve it.
- Once merged, go to Draft a new release in the Releases page.
- Make sure that the
Publish this Action to the GitHub Marketplacecheckbox is enabled
- Click "Choose a tag" and then "Create new tag", where the tag name
will be your version prefixed by a
v(e.g.v1.2.3). - Use a version number for the release title (e.g. "1.2.3").
- Add your release notes. If this is a major version make sure to include details about any breaking changes in the new version.
- Click "Publish Release".
You now have a tag and release using the semver version you used above. The last remaining thing to do is to update the major version branch to match the current release. This allows users to adopt a major version number (e.g. v4) in their workflows while automatically getting all the minor/patch updates.
As of v4.8.3, we use a branch (not a force-pushed tag) for the major version pointer. This is important because force-pushing tags breaks GitHub's auto-generated release changelog links (see #1035) and violates git's (unenforced) expectation that tags are immutable.
To update the major version branch:
git checkout main
git pull origin main
git branch -f v4 HEAD
git push origin v4