diff --git a/ci/README.md b/ci/README.md index 797f231aea626..389ef59f57b96 100644 --- a/ci/README.md +++ b/ci/README.md @@ -10,6 +10,14 @@ In order to ensure that the needed packages are generally available without buil Run [`update-pinned.sh`](./update-pinned.sh) to update it. +## GitHub specific code + +Some of the code is specific to GitHub. +This code is currently spread out over multiple places and written in both Bash and JavaScript. +The goal is to eventually have all GitHub specific code in `ci/github-script` and written in JavaScript via `actions/github-script`. +A lot of code has already been migrated, but some Bash code still remains. +New CI features need to be introduced in JavaScript, not Bash. + ## `ci/nixpkgs-vet.sh BASE_BRANCH [REPOSITORY]` Runs the [`nixpkgs-vet` tool](https://github.com/NixOS/nixpkgs-vet) on the HEAD commit, closely matching what CI does.