add a hint in the ci file, where the version of agda is picked

agda · Feb 10, 2022 · cbc79fc · cbc79fc
1 parent dfb086a
commit cbc79fc
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/.github/workflows/ci-ubuntu.yml b/.github/workflows/ci-ubuntu.yml
@@ -12,7 +12,7 @@ on:
 ########################################################################
 ## CONFIGURATION
 ##
-## See SETTINGS for the most important configuration variable: AGDA_COMMIT.
+## See SETTINGS for the most important configuration variable: AGDA_BRANCH.
 ## It has to be defined as a build step because it is potentially branch
 ## dependent.
 ##
@@ -45,9 +45,11 @@ jobs:
       ########################################################################
       ## SETTINGS
       ##
-      ## AGDA_COMMIT picks the version of Agda to use to build the library.
+      ## AGDA_BRANCH picks the version of Agda to use to build the library.
       ## It can either be a hash of a specific commit (to target a bugfix for
       ## instance) or a tag e.g. tags/v2.6.1.3 (to target a released version).
+      ## Please adjust README.md and INSTALL.md accordingly, if you change
+      ## AGDA_BRANCH.
       ########################################################################
 
       - name: Initialise variables