[PATCH] ci/config: correct instruction for CI preferences

[PATCH] ci/config: correct instruction for CI preferences

[Đoàn Trần Công Danh]

From e76eec3554 (ci: allow per-branch config for GitHub Actions,
2020-05-07), we started to allow contributors decide which branch
they want to build with GitHub Actions
by checking for a file named "ci/config/allow-ref".

In order to assist those contributors,
we provided a sample in "ci/config/allow-refs.sample",
and instructed them to drop the ".sample",
then commit that file to their repository.

We've misspelt the filename in that change.
Let's fix the spelling.

While we're at it, also instruct our contributors introduce that new
file to Git before commit, in case of they've never told Git before.

Signed-off-by: Đoàn Trần Công Danh <congdanhqx@gmail.com>
---

This is a merge from:
<20200508180047.GD637136@coredump.intra.peff.net>
<20200509012304.GB2111@danh.dev>

It's slipped over the crack.

Hence, it may need Peff's SoB.
Cc: Jeff King <peff@peff.net>
Cc: Junio C Hamano <gitster@pobox.com>

 ci/config/{allow-refs.sample => allow-ref.sample} | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
 rename ci/config/{allow-refs.sample => allow-ref.sample} (91%)

diff --git a/ci/config/allow-refs.sample b/ci/config/allow-ref.sample
similarity index 91%
rename from ci/config/allow-refs.sample
rename to ci/config/allow-ref.sample
index f157f1945a..af0e076f8a 100755
--- a/ci/config/allow-refs.sample
+++ b/ci/config/allow-ref.sample
@@ -7,8 +7,9 @@
 # your repository:
 #
 #   git checkout -b ci-config
-#   cp allow-refs.sample allow-refs
-#   $EDITOR allow-refs
+#   cp allow-ref.sample allow-ref
+#   $EDITOR allow-ref
+#   git add allow-ref
 #   git commit -am "implement my ci preferences"
 #   git push
 #
-- 
2.26.2.672.g232c24e857

Re: [PATCH] ci/config: correct instruction for CI preferences

[Jeff King]

On Mon, May 18, 2020 at 09:52:34PM +0700, Đoàn Trần Công Danh wrote:

> From e76eec3554 (ci: allow per-branch config for GitHub Actions,
> 2020-05-07), we started to allow contributors decide which branch
> they want to build with GitHub Actions
> by checking for a file named "ci/config/allow-ref".
> 
> In order to assist those contributors,
> we provided a sample in "ci/config/allow-refs.sample",
> and instructed them to drop the ".sample",
> then commit that file to their repository.
> 
> We've misspelt the filename in that change.
> Let's fix the spelling.
> 
> While we're at it, also instruct our contributors introduce that new
> file to Git before commit, in case of they've never told Git before.
> 
> Signed-off-by: Đoàn Trần Công Danh <congdanhqx@gmail.com>
> ---
> 
> This is a merge from:
> <20200508180047.GD637136@coredump.intra.peff.net>
> <20200509012304.GB2111@danh.dev>
> 
> It's slipped over the crack.

Yep, looks good. thanks for tying up this loose end.

> Hence, it may need Peff's SoB.
> Cc: Jeff King <peff@peff.net>

Signed-off-by: Jeff King <peff@peff.net>

-Peff