docs: add documentation for the reason why we need to have a setup st…

…ep for the container
github · Dec 9, 2024 · 51e71f8 · 51e71f8
1 parent 3951a82
commit 51e71f8
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/.github/workflows/__test-proxy.yml b/.github/workflows/__test-proxy.yml
diff --git a/pr-checks/checks/test-proxy.yml b/pr-checks/checks/test-proxy.yml
@@ -5,6 +5,9 @@ operatingSystems: ["ubuntu"]
 container:
   image: ubuntu:22.04
 container-init-steps:
+  # These steps are required to initialise the `gh` cli in a container that doesn't
+  # come pre-installed with it. The reason for that is that this is later
+  # needed by the `prepare-test` workflow to find the latest release of CodeQL. 
   name: Set up GitHub CLI
   run: |
     apt update