From: "Chris. Webster via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: "Chris. Webster" <chris@webstech.net>,
"Chris. Webster" <chris@webstech.net>
Subject: [PATCH 1/2] Make `check-whitespace` failures more helpful
Date: Fri, 16 Dec 2022 08:31:59 +0000 [thread overview]
Message-ID: <67f60e4e5cbb470bbf3f556f962403af5dd5938c.1671179520.git.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.1444.git.1671179520.gitgitgadget@gmail.com>
From: "Chris. Webster" <chris@webstech.net>
Add the errors to the job summary along with suggested
commands to fix the problem.
Signed-off-by: Chris. Webster <chris@webstech.net>
---
.github/workflows/check-whitespace.yml | 39 +++++++++++++++++++-------
1 file changed, 29 insertions(+), 10 deletions(-)
diff --git a/.github/workflows/check-whitespace.yml b/.github/workflows/check-whitespace.yml
index ad3466ad16e..3a99073bc33 100644
--- a/.github/workflows/check-whitespace.yml
+++ b/.github/workflows/check-whitespace.yml
@@ -13,38 +13,57 @@ jobs:
check-whitespace:
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v2
+ - uses: actions/checkout@v3
with:
fetch-depth: 0
- name: git log --check
id: check_out
run: |
- log=
+ problems=()
commit=
- while read dash etc
+ commitText=
+ lastcommit=
+ while read dash sha etc
do
case "${dash}" in
"---")
- commit="${etc}"
+ if test -z "${commit}"
+ then
+ lastcommit=${sha}
+ fi
+ commit="${sha}"
+ commitText="${sha} ${etc}"
;;
"")
;;
*)
if test -n "${commit}"
then
- log="${log}\n${commit}"
+ problems+=("" "--- ${commitText}")
echo ""
- echo "--- ${commit}"
+ echo "--- ${commitText}"
+ commit=
fi
- commit=
- log="${log}\n${dash} ${etc}"
- echo "${dash} ${etc}"
+ problems+=("${dash} ${sha} ${etc}")
+ echo "${problems[-1]}"
;;
esac
done <<< $(git log --check --pretty=format:"---% h% s" ${{github.event.pull_request.base.sha}}..)
- if test -n "${log}"
+ if test ${#problems[*]} -gt 0
then
+ if test -z "${commit}"
+ then
+ lastcommit=${{github.event.pull_request.base.sha}}
+ fi
+ echo "A whitespace issue was found in one or more of the commits." >$GITHUB_STEP_SUMMARY
+ echo "" >>$GITHUB_STEP_SUMMARY
+ echo "Run \`git rebase --whitespace=fix ${lastcommit}\` and \`git push --force\` to correct the problem." >>$GITHUB_STEP_SUMMARY
+ for i in "${problems[@]}"
+ do
+ echo "${i}" >>$GITHUB_STEP_SUMMARY
+ done
+
exit 2
fi
--
gitgitgadget
next prev parent reply other threads:[~2022-12-16 8:32 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-12-16 8:31 [PATCH 0/2] Make check-whitespace failures more helpful Chris. Webster via GitGitGadget
2022-12-16 8:31 ` Chris. Webster via GitGitGadget [this message]
2022-12-16 10:06 ` [PATCH 1/2] Make `check-whitespace` " Junio C Hamano
2022-12-20 0:30 ` Chris Webster
2022-12-20 1:36 ` Junio C Hamano
2022-12-20 5:50 ` Chris Webster
2022-12-16 8:32 ` [PATCH 2/2] Improve check-whitespace output Chris. Webster via GitGitGadget
2022-12-16 10:13 ` Junio C Hamano
2022-12-20 0:33 ` Chris Webster
2022-12-20 0:35 ` [PATCH v2 0/3] Make check-whitespace failures more helpful Chris. Webster via GitGitGadget
2022-12-20 0:35 ` [PATCH v2 1/3] ci (check-whitespace): suggest fixes for errors Chris. Webster via GitGitGadget
2022-12-20 7:34 ` Đoàn Trần Công Danh
2022-12-20 19:55 ` Chris Webster
2022-12-21 1:53 ` Đoàn Trần Công Danh
2022-12-21 6:08 ` Chris Webster
2022-12-21 13:46 ` Đoàn Trần Công Danh
2022-12-20 0:35 ` [PATCH v2 2/3] ci (check-whitespace): add links to job output Chris. Webster via GitGitGadget
2022-12-20 0:35 ` [PATCH v2 3/3] ci (check-whitespace): move to actions/checkout@v3 Chris. Webster via GitGitGadget
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=67f60e4e5cbb470bbf3f556f962403af5dd5938c.1671179520.git.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=chris@webstech.net \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).