You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
gh-35108: src/doc/en/developer/portability_testing.rst: Update after migration
…to GitHub (no more sagetrac-mirror)
<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes#1234" use "Introduce new method to
calculate 1+1"
-->
### 📚 Description
We update the documentation on portability testing.
- Instead of referring to trac and sagetrac-mirror, we direct users to
use their personal fork
- We remove the description of a method using pull requests because
#34942 disabled it
- We update according to changed defaults on GH Actions.
<!-- Describe your changes here in detail -->
<!-- Why is this change required? What problem does it solve? -->
<!-- If it resolves an open issue, please link to the issue here. For
example "Closes#1337" -->
### 📝 Checklist
<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
- [x] I have made sure that the title is self-explanatory and the
description concisely explains the PR.
- [x] I have linked an issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation accordingly.
### ⌛ Dependencies
<!-- List all open pull requests that this PR logically depends on -->
<!--
- #xyz: short description why this is a dependency
- #abc: ...
-->
Test running at:
https://github.com/mkoeppe/sage/actions/runs/4911075567/jobs/8768884045
(the "standard", "minimal" etc. jobs without "-pre" should now work).
URL: #35108
Reported by: Matthias Köppe
Reviewer(s): Dima Pasechnik, Matthias Köppe, Tobias Diez
and has a time limit of 6h per job. This is just barely enough for a
972
-
typical ``minimal`` build followed by ``make ptest`` to succeed; and
973
-
plenty of time for a typical ``standard`` build to succeed.
978
+
and has a time limit of 6h per job. This could be just barely enough for a
979
+
typical ``minimal`` build followed by ``make ptest`` to succeed; for
980
+
added robustness, we split it into two jobs. Our workflow stores
981
+
Docker images corresponding to various build phases within these two
982
+
jobs on `GitHub Packages <https://github.com/features/packages>`_ (ghcr.io).
983
+
984
+
Build logs can be inspected during the run and become available as
985
+
"artifacts" when all jobs of the workflow have finished. Each job
986
+
generates one tarball. "Annotations" highlight certain top-level
987
+
errors or warnings issued during the build.
988
+
989
+
In addition to these automatic runs in our main repository, all Sage
990
+
developers can run the same tests on GitHub Actions in their personal
991
+
forks of the Sage repository. To prepare this, `enable GitHub Actions <https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#managing-github-actions-permissions-for-your-repository>`_
992
+
in your fork of the Sage repository.
993
+
994
+
As usual we assume that ``origin`` is the name of the remote
995
+
corresponding to your GitHub fork of the Sage repository::
Build logs become available as "artifacts" when all jobs of the
976
-
workflow have finished. Each job generates one tarball.
977
-
"Annotations" highlight certain top-level errors or warnings issued
978
-
during the build.
1001
+
Then the following procedure triggers a run of tests with the default set
1002
+
of system configurations.
979
1003
980
-
The following procedure triggers a run of tests with the default set of
981
-
system configurations.
1004
+
- Push your branch to ``origin`` (your fork).
982
1005
983
-
- Push your changes to trac.
984
-
- Go to the `Actions page on the GitHub mirror <https://github.com/sagemath/sagetrac-mirror/actions>`_ and select the workflow you would like to run.
985
-
- Click on "Run workflow" above the list of workflow runs and select the branch where the workflow will run.
1006
+
- Go to the Actions tab of your fork and select the workflow you would like to run,
1007
+
for example "CI Linux".
986
1008
987
-
For more information, see the `GitHub documentation <https://docs.github.com/en/free-pro-team@latest/actions/managing-workflow-runs/manually-running-a-workflow>`_.
1009
+
- Click on "Run workflow" above the list of workflow runs and select
1010
+
your branch as the branch on which the workflow will run.
988
1011
989
-
Alternatively, you can create and push a custom tag in order to trigger a run of tests as follows.
990
-
Let's assume that ``my-github`` is the name of
991
-
the remote corresponding to your GitHub fork of the Sage repository::
1012
+
For more information, see the `GitHub documentation
0 commit comments