diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 5c2de7b37..dce7395a4 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,3 +1,10 @@ +# See ../../ci/doc/README.{md,pdf} for documentation about continuous +# integration and testing of Proof General. +# +# The versions to be tested in between the CIPG markers are now and +# then automatically updated. Please consider this when changing this +# file. +# name: CI on: @@ -20,12 +27,16 @@ jobs: strategy: matrix: emacs_version: + # The content between the CIPG markers is automatically + # changed by the cipg program. Do not change these markers. + # CIPG change marker: build-emacs-versions - 26.3 - 27.1 - 27.2 - 28.1 - 28.2 - 29.1 + # CIPG change marker end # at most 20 concurrent jobs per free account # cf. https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#usage-limit max-parallel: 4 @@ -65,8 +76,13 @@ jobs: # I don't think we need to check with all emacs # versions. The latest two should be enough, maybe even # only the latest one. + # + # The content between the CIPG markers is automatically + # changed by the cipg program. Do not change these markers. + # CIPG change marker: magic-emacs-version - 28.2 - 29.1 + # CIPG change marker end # don't cancel all in-progress jobs if one matrix job fails: fail-fast: false @@ -89,6 +105,9 @@ jobs: strategy: matrix: coq_emacs_version: + # The content between the CIPG markers is automatically + # changed by the cipg program. Do not change these markers. + # CIPG change marker: test-coq-emacs-versions - coq-8.11-emacs-26.3 - coq-8.11-emacs-29.1 - coq-8.12-emacs-27.1 @@ -122,6 +141,7 @@ jobs: - coq-8.19-rc-emacs-28.1 - coq-8.19-rc-emacs-28.2 - coq-8.19-rc-emacs-29.1 + # CIPG change marker end # at most 20 concurrent jobs per free account # cf. https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#usage-limit max-parallel: 6 @@ -162,6 +182,9 @@ jobs: strategy: matrix: coq_emacs_version: + # The content between the CIPG markers is automatically + # changed by the cipg program. Do not change these markers. + # CIPG change marker: compile-coq-emacs-versions - coq-8.11-emacs-26.3 - coq-8.11-emacs-29.1 - coq-8.12-emacs-27.1 @@ -195,6 +218,7 @@ jobs: - coq-8.19-rc-emacs-28.1 - coq-8.19-rc-emacs-28.2 - coq-8.19-rc-emacs-29.1 + # CIPG change marker end # don't cancel all in-progress jobs if one matrix job fails: fail-fast: false steps: @@ -228,6 +252,9 @@ jobs: strategy: matrix: coq_emacs_version: + # The content between the CIPG markers is automatically + # changed by the cipg program. Do not change these markers. + # CIPG change marker: simple-coq-emacs-versions - coq-8.11-emacs-26.3 - coq-8.11-emacs-29.1 - coq-8.12-emacs-27.1 @@ -261,6 +288,7 @@ jobs: - coq-8.19-rc-emacs-28.1 - coq-8.19-rc-emacs-28.2 - coq-8.19-rc-emacs-29.1 + # CIPG change marker end # don't cancel all in-progress jobs if one matrix job fails: fail-fast: false @@ -298,12 +326,16 @@ jobs: strategy: matrix: emacs_version: + # The content between the CIPG markers is automatically + # changed by the cipg program. Do not change these markers. + # CIPG change marker: indent-emacs-versions - 26.3 - 27.1 - 27.2 - 28.1 - 28.2 - 29.1 + # CIPG change marker end max-parallel: 4 # don't cancel all in-progress jobs if one matrix job fails: fail-fast: false @@ -329,12 +361,16 @@ jobs: strategy: matrix: emacs_version: + # The content between the CIPG markers is automatically + # changed by the cipg program. Do not change these markers. + # CIPG change marker: qrhl-emacs-versions - 26.3 - 27.1 - 27.2 - 28.1 - 28.2 - 29.1 + # CIPG change marker end max-parallel: 4 # don't cancel all in-progress jobs if one matrix job fails: fail-fast: false diff --git a/ci/doc/README.md b/ci/doc/README.md index 071117820..d8ac640a6 100644 --- a/ci/doc/README.md +++ b/ci/doc/README.md @@ -10,6 +10,11 @@ linkcolor: blue This document describes the general strategy for testing Proof General with GitHub actions and for building the necessary containers. +**Note:** The portions in this file between the CIPG markers (which +are invisible in the PDF version) are now and then automatically +updated by the `cipg` program. Please consider this when changing this +file. + The file `.github/workflows/test.yml` defines 6 jobs. build @@ -78,9 +83,13 @@ standard support date is in the future. Currently, the first actively supported versions are -| Coq | 8.11 | -|-------+------| -| Emacs | 26.3 | + + +| Coq | 8.11 | +|-------+-------| +| Emacs | 26.3 | + The set of passively supported Coq/Emacs version pairs is work in progress. @@ -140,8 +149,17 @@ we build containers for the historic pairs of the last 6 years as passively supported versions. -This results in 48 containers. - +This results in + + +48 + +containers. + + + | | 26.1 | 26.2 | 26.3 | 27.1 | 27.2 | 28.1 | 28.2 | 29.1 | |---------+------+------+------+------+------+------+------+------| | 8.8 | H | | | | | | | | @@ -156,6 +174,7 @@ This results in 48 containers. | 8.17 | | | X | X | X | X | X | X | | 8.18 | | | X | X | X | X | X | X | | 8.19-rc | RC | RC | RC | RC | RC | RC | RC | RC | + In the table above, @@ -248,9 +267,17 @@ following points is true for *cv* and *ev*. Running Proof General interaction tests with Coq for passively supported versions is work in progress. -This results in 33 version pairs for the Proof General interaction -tests with Coq. - +This results in + + +33 + +version pairs for the Proof General interaction tests with Coq. + + + | | 26.1 | 26.2 | 26.3 | 27.1 | 27.2 | 28.1 | 28.2 | 29.1 | |---------+------+------+------+------+------+------+------+------| | 8.8 | | | | | | | | | @@ -265,6 +292,7 @@ tests with Coq. | 8.17 | | | X | X | | | X | SUP | | 8.18 | | | X | X | N | N | X | X | | 8.19-rc | RC | RC | RC | RC | RC | RC | RC | RC | + See [Container build strategy](#contbuild) for an explanation of the symbols in the table. diff --git a/ci/doc/README.pdf b/ci/doc/README.pdf index 5c5956dbf..988a22a28 100644 Binary files a/ci/doc/README.pdf and b/ci/doc/README.pdf differ