diff mbox series

[v2,2/2] SubmittingPatches: advertise GitHub Actions CI

Message ID 24a8fefe5add61d557a29f070bd2ca0d0f43d844.1588607262.git.congdanhqx@gmail.com (mailing list archive)
State New, archived
Headers show
Series Limit GitHub Actions to designated branches | expand

Commit Message

Đoàn Trần Công Danh May 4, 2020, 3:49 p.m. UTC
From 889cacb689 (ci: configure GitHub Actions for CI/PR, 2020-04-11),
GitHub Actions was introduced as an alternative CI system for Git
project.

Let's advertise it to Git's contributors to help them test Git on
various platforms before submitting to Git.

Signed-off-by: Đoàn Trần Công Danh <congdanhqx@gmail.com>
---
 Documentation/SubmittingPatches | 5 +++++
 1 file changed, 5 insertions(+)

Comments

Junio C Hamano May 4, 2020, 4:37 p.m. UTC | #1
Đoàn Trần Công Danh  <congdanhqx@gmail.com> writes:

> +Alternately, you can use GitHub Actions (which supports testing your changes
> +on Linux, macOS, and Windows) by pushing into a branch whose name starts
> +with "for-ci/" or opening a GitHub's Pull Request against
> +https://github.com/git/git.git

Can you tighten the description of "for-ci/" a bit?  It's not like
the convention is offered in _any_ repository, but it is active only
if you push to a fork of git.git, right?  If your fork is a fork of
a fork, what happens (e.g. github.com/gitster/git is marked as a
fork of git/git; when somebody forks from gitster/git, would they
also get the for-ci/ convention)?

Thanks.
Đoàn Trần Công Danh May 5, 2020, 12:46 a.m. UTC | #2
On 2020-05-04 09:37:11-0700, Junio C Hamano <gitster@pobox.com> wrote:
> Đoàn Trần Công Danh  <congdanhqx@gmail.com> writes:
> 
> > +Alternately, you can use GitHub Actions (which supports testing your changes
> > +on Linux, macOS, and Windows) by pushing into a branch whose name starts
> > +with "for-ci/" or opening a GitHub's Pull Request against
> > +https://github.com/git/git.git
> 
> Can you tighten the description of "for-ci/" a bit?  It's not like
> the convention is offered in _any_ repository, but it is active only
> if you push to a fork of git.git, right?

The convention will work in any repository with
"$TOPDIR/.github/workflows/*.yml" exists.
Since GitHub Actions will look into the file ".github/workflows/*.yml"
in current repository.

> If your fork is a fork of
> a fork, what happens (e.g. github.com/gitster/git is marked as a
> fork of git/git; when somebody forks from gitster/git, would they
> also get the for-ci/ convention)?

Yes, they'll get that convention.
diff mbox series

Patch

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 4515cab519..741867dfe3 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -78,6 +78,11 @@  on open source projects), you can use their Travis CI integration to
 test your changes on Linux, Mac (and hopefully soon Windows).  See
 GitHub-Travis CI hints section for details.
 
+Alternately, you can use GitHub Actions (which supports testing your changes
+on Linux, macOS, and Windows) by pushing into a branch whose name starts
+with "for-ci/" or opening a GitHub's Pull Request against
+https://github.com/git/git.git
+
 Do not forget to update the documentation to describe the updated
 behavior and make sure that the resulting documentation set formats
 well (try the Documentation/doc-diff script).