Skip to content

Commit

Permalink
Remove instructions for merging Dependabot PRs
Browse files Browse the repository at this point in the history
These are no longer required, since the bot will update the `dist` directory.
  • Loading branch information
bigdaz authored Jun 28, 2024
1 parent 1da1cc9 commit c04155e
Showing 1 changed file with 1 addition and 16 deletions.
17 changes: 1 addition & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,6 @@ The `build` script in the project root provides a convenient way to perform many
3. `./build init-scripts` will run the init-script integration tests
4. `./build act <act-commands>` will run `act` after building local changes (see below)

## How to merge a Dependabot PR

The "distribution" for a GitHub Action is checked into the repository itself.
In the case of these actions, the transpiled sources are committed to the `dist` directory.
Any production dependencies are inlined into the distribution.
So if a Dependabot PR updates a production dependency (or a dev dependency that changes the distribution, like the Typescript compiler),
then a manual step is required to rebuild the dist and commit.

The simplest process to follow is:
1. Checkout the dependabot branch locally eg: `git checkout dependabot/npm_and_yarn/actions/github-5.1.0`
2. In the `sources` directory, run `npm install` to download NPM dependencies
3. In the `sources` directory, run `npm run build` to regenerate the distribution
4. Push the changes to the dependabot branch
5. If/when the checks pass, you can merge the dependabot PR

## Using `act` to run integ-test workflows locally

It's possible to run GitHub Actions workflows locally with https://nektosact.com/.
Expand All @@ -46,4 +31,4 @@ Tips:
- Add the following lines to `~/.actrc`:
- `--container-daemon-socket -` : Prevents "error while creating mount source path", and yes that's a solitary dash at the end
- `--matrix os:ubuntu-latest` : Avoids a lot of logging about unsupported runners being skipped
- Runners don't have `java` installed by default, so all workflows that run Gradle require a `setup-java` step.
- Runners don't have `java` installed by default, so all workflows that run Gradle require a `setup-java` step.

0 comments on commit c04155e

Please sign in to comment.