@@ -916,7 +916,8 @@ Automatic parallel tox runs on GitHub Actions
916916
917917The Sage source tree includes a default configuration for GitHub
918918Actions that runs tox on a multitude of platforms on every pull
919- request to a repository for which GitHub Actions are enabled.
919+ request and on every push of a tag (but not of a branch) to a
920+ repository for which GitHub Actions are enabled.
920921
921922This is defined in the file ``$SAGE_ROOT/.github/workflows/tox.yml ``.
922923
@@ -936,8 +937,29 @@ workflow have finished. Each job generates one tarball.
936937"Annotations" highlight certain top-level errors or warnings issued
937938during the build.
938939
939- The following procedure seems to work well for testing branches during
940- development:
940+ The following procedure triggers a run of tests with the default set of
941+ system configurations. Let's assume that ``github `` is the name of
942+ the remote corresponding to your GitHub fork of the Sage repository::
943+
944+ $ git remote -v | grep /my-github
945+ my-github https://github.com/mkoeppe/sage.git (fetch)
946+ my-github https://github.com/mkoeppe/sage.git (push)
947+
948+ - Create a ("lightweight", not "annotated") tag with an arbitrary
949+ name, say ``ci `` (for "Continuous Integration")::
950+
951+ git tag -f ci
952+
953+ - Then push the tag to your GitHub repository::
954+
955+ git push -f my-github ci
956+
957+ (In both commands, the "force" option (``-f ``) allows overwriting a
958+ previous tag of that name.)
959+
960+ For testing branches against a custom set of system configurations
961+ during development, the following procedure seems to work well. It
962+ avoids changing the CI configuration on your development branch:
941963
942964- Create a branch from a recent beta release that contains the default
943965 GitHub Actions configuration; name it ``TESTER ``, say.
@@ -951,6 +973,9 @@ development:
951973 pull request against the ``TESTER `` branch. This will trigger the
952974 GitHub Actions workflow.
953975
976+ You will find a workflow status page in the "Actions" tab of your
977+ repository.
978+
954979Here is how to read it. Each of the items in the left pane represents
955980a full build of Sage on a particular system configuration. A test
956981item in the left pane is marked with a green checkmark in the left
0 commit comments