SubmittingPatches: replace discussion of Travis with GitHub Actions
Replace the discussion of Travis CI added in 0e5d028a7a0 (Documentation: add setup instructions for Travis CI, 2016-05-02) with something that covers the GitHub Actions added in 889cacb6897 (ci: configure GitHub Actions for CI/PR, 2020-04-11). The setup is trivial compared to using Travis, and it even works on Windows (that "hopefully soon" comment was probably out-of-date on Travis as well). Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Ævar Arnfjörð Bjarmason committed
Jul 22, 2021 at 14:11 UTC
f003a91f5c5695a44a94efe9171bc905fbfa27ce
1 file changed
+17
-32
Documentation/SubmittingPatches
+17
-32
@@ -74,10 +74,9 @@ the feature triggers the new behavior when it should, and to show the
74
feature does not trigger when it shouldn't. After any code change, make
75
sure that the entire test suite passes.
76
77
-If you have an account at GitHub (and you can get one for free to work
78
-on open source projects), you can use their Travis CI integration to
79
-test your changes on Linux, Mac (and hopefully soon Windows). See
80
-GitHub-Travis CI hints section for details.
77
+Pushing to a fork of https://github.com/git/git will use their CI
78
+integration to test your changes on Linux, Mac and Windows. See the
79
+<<GHCI,GitHub CI>> section for details.
80
81
Do not forget to update the documentation to describe the updated
82
behavior and make sure that the resulting documentation set formats
@@ -449,13 +448,12 @@ their trees themselves.
448
entitled "What's cooking in git.git" and "What's in git.git" giving
449
the status of various proposed changes.
450
452
-[[travis]]
453
-== GitHub-Travis CI hints
451
+== GitHub CI[[GHCI]]]
452
455
-With an account at GitHub (you can get one for free to work on open
456
-source projects), you can use Travis CI to test your changes on Linux,
457
-Mac (and hopefully soon Windows). You can find a successful example
458
-test build here: https://travis-ci.org/git/git/builds/120473209
453
+With an account at GitHub, you can use GitHub CI to test your changes
454
+on Linux, Mac and Windows. See
455
+https://github.com/git/git/actions/workflows/main.yml for examples of
456
+recent CI runs.
457
458
Follow these steps for the initial setup:
459
@@ -463,31 +461,18 @@ Follow these steps for the initial setup:
461
You can find detailed instructions how to fork here:
462
https://help.github.com/articles/fork-a-repo/
463
466
-. Open the Travis CI website: https://travis-ci.org
467
-
468
-. Press the "Sign in with GitHub" button.
469
-
470
-. Grant Travis CI permissions to access your GitHub account.
471
- You can find more information about the required permissions here:
472
- https://docs.travis-ci.com/user/github-oauth-scopes
473
-
474
-. Open your Travis CI profile page: https://travis-ci.org/profile
475
-
476
-. Enable Travis CI builds for your Git fork.
477
-
478
-After the initial setup, Travis CI will run whenever you push new changes
464
+After the initial setup, CI will run whenever you push new changes
465
to your fork of Git on GitHub. You can monitor the test state of all your
480
-branches here: https://travis-ci.org/__<Your GitHub handle>__/git/branches
466
+branches here: https://github.com/<Your GitHub handle>/git/actions/workflows/main.yml
467
468
If a branch did not pass all test cases then it is marked with a red
483
-cross. In that case you can click on the failing Travis CI job and
484
-scroll all the way down in the log. Find the line "<-- Click here to see
485
-detailed test output!" and click on the triangle next to the log line
486
-number to expand the detailed test output. Here is such a failing
487
-example: https://travis-ci.org/git/git/jobs/122676187
488
-
489
-Fix the problem and push your fix to your Git fork. This will trigger
490
-a new Travis CI build to ensure all tests pass.
469
+cross. In that case you can click on the failing job and navigate to
470
+"ci/run-build-and-tests.sh" and/or "ci/print-test-failures.sh". You
471
+can also download "Artifacts" which are tarred (or zipped) archives
472
+with test data relevant for debugging.
473
+
474
+Then fix the problem and push your fix to your GitHub fork. This will
475
+trigger a new CI build to ensure all tests pass.
476
477
[[mua]]
478
== MUA specific hints