# [PATCH 1/2] ci: fix indentation of the `ci-config` job 6 messages from 2020-09-01 to 2020-09-02. Participants: Johannes Schindelin via GitGitGadget, Jeff King, Junio C Hamano. Thread: https://gitlist.dev/t/54173 ## Johannes Schindelin via GitGitGadget, 2020-09-01 20:19 Subject: [PATCH 1/2] ci: fix indentation of the `ci-config` job Message-ID: URL: https://gitlist.dev/e/b5363e282f69570e34ffb806f7a62e00e39b98bc.1598991568.git.gitgitgadget%40gmail.com In-Reply-To: ``` From: Johannes Schindelin The section added in e76eec35540f (ci: allow per-branch config for GitHub Actions, 2020-05-07) contains a `&&`-chain that connects several commands. The first command is actually so long that it stretches over multiple lines, and as per usual, the continuation lines are indented one more level than the first. However, the subsequent commands in the `&&`-chain were also indented one more level than the first command, which was almost certainly unintended. Signed-off-by: Johannes Schindelin --- .github/workflows/main.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 30425404eb..6fd1d1a2c8 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -23,8 +23,8 @@ jobs: --filter=blob:none \ https://github.com/${{ github.repository }} \ config-repo && - cd config-repo && - git checkout HEAD -- ci/config + cd config-repo && + git checkout HEAD -- ci/config - id: check-ref name: check whether CI is enabled for ref run: | -- gitgitgadget ``` ## Johannes Schindelin via GitGitGadget, 2020-09-01 20:19 Subject: [PATCH 2/2] ci: avoid ugly "failure" in the `ci-config` job Message-ID: URL: https://gitlist.dev/e/b92374e69192d57bcb11fb2573beb4e9aee339a9.1598991568.git.gitgitgadget%40gmail.com In-Reply-To: ``` From: Johannes Schindelin In the common case where users have _not_ pushed a `ci-config` branch to configure which branches should be included in the GitHub workflow runs, there is a big fat ugly annotation about a failure in the run's log: X Check failure on line 1 in .github @github-actions github-actions / ci-config .github#L1 Process completed with exit code 128. The reason is that the `ci-config` job tries to clone that `ci-config` branch, and even if it is configured to continue on error, the annotation is displayed, and it is distracting. Let's just handle this on the shell script level, so that the job's step is not marked as a failure. Signed-off-by: Johannes Schindelin --- .github/workflows/main.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 6fd1d1a2c8..fcfd138ff1 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -12,7 +12,6 @@ jobs: enabled: ${{ steps.check-ref.outputs.enabled }} steps: - name: try to clone ci-config branch - continue-on-error: true run: | git -c protocol.version=2 clone \ --no-tags \ @@ -24,7 +23,7 @@ jobs: https://github.com/${{ github.repository }} \ config-repo && cd config-repo && - git checkout HEAD -- ci/config + git checkout HEAD -- ci/config || : ignore - id: check-ref name: check whether CI is enabled for ref run: | -- gitgitgadget ``` ## Johannes Schindelin via GitGitGadget, 2020-09-01 20:19 Subject: [PATCH 0/2] ci: avoid ugly "failure" annotation in the GitHub workflow Message-ID: URL: https://gitlist.dev/e/pull.719.git.1598991568.gitgitgadget%40gmail.com ``` Whenever the GitHub workflow runs in a fork that does not contain the special-purpose ci-config branch, a big fat failure annotation greets the casual reader. See e.g. https://github.com/gitgitgadget/git/actions/runs/233438295 This is caused by the (non-fatal) failure to clone said branch. Let's avoid that. It's distracting. Johannes Schindelin (2): ci: fix indentation of the `ci-config` job ci: avoid ugly "failure" in the `ci-config` job .github/workflows/main.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) base-commit: e19713638985533ce461db072b49112da5bd2042 Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-719%2Fdscho%2Favoid-error-in-ci-config-v1 Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-719/dscho/avoid-error-in-ci-config-v1 Pull-Request: https://github.com/gitgitgadget/git/pull/719 -- gitgitgadget ``` ## Jeff King, 2020-09-02 00:33 Subject: Re: [PATCH 1/2] ci: fix indentation of the `ci-config` job Message-ID: <20200902003340.GB3294015@coredump.intra.peff.net> URL: https://gitlist.dev/e/20200902003340.GB3294015%40coredump.intra.peff.net In-Reply-To: ``` On Tue, Sep 01, 2020 at 08:19:26PM +0000, Johannes Schindelin via GitGitGadget wrote: > From: Johannes Schindelin > > The section added in e76eec35540f (ci: allow per-branch config for > GitHub Actions, 2020-05-07) contains a `&&`-chain that connects several > commands. The first command is actually so long that it stretches over > multiple lines, and as per usual, the continuation lines are indented one > more level than the first. > > However, the subsequent commands in the `&&`-chain were also indented > one more level than the first command, which was almost certainly > unintended. Yeah, I'm pretty sure this was unintentional in my original (and got carried through the recent re-indentation). -Peff ``` ## Jeff King, 2020-09-02 00:40 Subject: Re: [PATCH 2/2] ci: avoid ugly "failure" in the `ci-config` job Message-ID: <20200902004030.GC3294015@coredump.intra.peff.net> URL: https://gitlist.dev/e/20200902004030.GC3294015%40coredump.intra.peff.net In-Reply-To: ``` On Tue, Sep 01, 2020 at 08:19:27PM +0000, Johannes Schindelin via GitGitGadget wrote: > From: Johannes Schindelin > > In the common case where users have _not_ pushed a `ci-config` branch to > configure which branches should be included in the GitHub workflow runs, > there is a big fat ugly annotation about a failure in the run's log: > > X Check failure on line 1 in .github > > @github-actions github-actions / ci-config > > .github#L1 > > Process completed with exit code 128. > > The reason is that the `ci-config` job tries to clone that `ci-config` > branch, and even if it is configured to continue on error, the > annotation is displayed, and it is distracting. Hmm. I thought we handled this with the "continue-on-error" flag. Unsurprisingly I have a ci-config branch in my repo, but git/git doesn't, and here's a sample run there: https://github.com/git/git/runs/1053619435?check_suite_focus=true Both the "ci-config" task, as well as the individual "try to clone ci-config branch" step are marked with a green check. ...Oh, I think I see what you mean. In the "Annotations" summary we still see an ugly "X" box. > Let's just handle this on the shell script level, so that the job's step > is not marked as a failure. OK, that makes sense. We could do differentiate clone failing versus cd versus checkout (or for that matter, clone failing because the branch doesn't exist versus a network error). But it's probably not worth getting too fancy. My next question was going to be: should we also drop the continue-on-error flag? But I see you did that already. So the patch looks good to me. Sorry for introducing CI noise in the first place. :) -Peff ``` ## Junio C Hamano, 2020-09-02 19:21 Subject: Re: [PATCH 0/2] ci: avoid ugly "failure" annotation in the GitHub workflow Message-ID: URL: https://gitlist.dev/e/xmqqk0xcaste.fsf%40gitster.c.googlers.com In-Reply-To: ``` "Johannes Schindelin via GitGitGadget" writes: > Whenever the GitHub workflow runs in a fork that does not contain the > special-purpose ci-config branch, a big fat failure annotation greets the > casual reader. See e.g. > https://github.com/gitgitgadget/git/actions/runs/233438295 > > This is caused by the (non-fatal) failure to clone said branch. Let's avoid > that. It's distracting. Thanks. Anything that reduces the CI noise is very much welcomed. ```