From c04155e2ca6a044413092a1d7aa4ee75cff2c463 Mon Sep 17 00:00:00 2001 From: Daz DeBoer Date: Thu, 27 Jun 2024 19:32:31 -0600 Subject: [PATCH] Remove instructions for merging Dependabot PRs These are no longer required, since the bot will update the `dist` directory. --- CONTRIBUTING.md | 17 +---------------- 1 file changed, 1 insertion(+), 16 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6336524..6c3313d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 ` 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/. @@ -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. \ No newline at end of file +- Runners don't have `java` installed by default, so all workflows that run Gradle require a `setup-java` step.