Skip to content

Latest commit

 

History

History

workflows

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

GitHub Actions Workflows

Some architectural notes about key decisions and concepts in our workflows:

  • Instead of pull_request we use pull_request_target for all PR-related workflows. This has the advantage that those workflows will run without prior approval for external contributors.

  • Running on pull_request_target also optionally provides us with a GH_TOKEN with elevated privileges (write access), which we need to do things like adding labels, requesting reviewers or pushing branches. Note about security: We need to be careful to limit the scope of elevated privileges as much as possible. Thus they should be lowered to the minimum with permissions: {} in every workflow by default.

  • By definition pull_request_target runs in the context of the base of the pull request. This means, that the workflow files to run will be taken from the base branch, not the PR, and actions/checkout will not checkout the PR, but the base branch, by default. To protect our secrets, we need to make sure to never execute code from the pull request and always evaluate or build nix code from the pull request with the sandbox enabled.

  • To test the pull request's contents, we checkout the "test merge commit". This is a temporary commit that GitHub creates automatically as "what would happen, if this PR was merged into the base branch now?". The checkout could be done via the virtual branch refs/pull/<pr-number>/merge, but doing so would cause failures when this virtual branch doesn't exist (anymore). This can happen when the PR has conflicts, in which case the virtual branch is not created, or when the PR is getting merged while workflows are still running, in which case the branch won't exist anymore at the time of checkout. Thus, we use the get-merge-commit.yml workflow to check whether the PR is mergeable and the test merge commit exists and only then run the relevant jobs.

  • Various workflows need to make comparisons against the base branch. In this case, we checkout the parent of the "test merge commit" for best results. Note, that this is not necessarily the same as the default commit that actions/checkout would use, which is also a commit from the base branch (see above), but might be older.

Terminology

  • base commit: The pull_request_target event's context commit, i.e. the base commit given by GitHub Actions. Same as github.event.pull_request.base.sha.
  • head commit: The HEAD commit in the pull request's branch. Same as github.event.pull_request.head.sha.
  • merge commit: The temporary "test merge commit" that GitHub Actions creates and updates for the pull request. Same as refs/pull/${{ github.event.pull_request.number }}/merge.
  • target commit: The base branch's parent of the "test merge commit" to compare against.