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 2/2] Improve check-whitespace output
Date: Fri, 16 Dec 2022 08:32:00 +0000 [thread overview]
Message-ID: <cdc2b1aae81f8c37b4e71cb3e0e382cf82de2272.1671179520.git.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.1444.git.1671179520.gitgitgadget@gmail.com>
From: "Chris. Webster" <chris@webstech.net>
A message in the step log will refer to the Summary output.
The job summary output now has links to the commits and files.
Signed-off-by: Chris. Webster <chris@webstech.net>
---
.github/workflows/check-whitespace.yml | 34 +++++++++++++++++++-------
1 file changed, 25 insertions(+), 9 deletions(-)
diff --git a/.github/workflows/check-whitespace.yml b/.github/workflows/check-whitespace.yml
index 3a99073bc33..da557fd5914 100644
--- a/.github/workflows/check-whitespace.yml
+++ b/.github/workflows/check-whitespace.yml
@@ -20,46 +20,62 @@ jobs:
- name: git log --check
id: check_out
run: |
+ baseSha=${{github.event.pull_request.base.sha}}
problems=()
commit=
commitText=
- lastcommit=
+ commitTextmd=
+ goodparent=
while read dash sha etc
do
case "${dash}" in
"---")
if test -z "${commit}"
then
- lastcommit=${sha}
+ goodparent=${sha}
fi
commit="${sha}"
commitText="${sha} ${etc}"
+ commitTextmd="[${sha}](https://github.com/${{ github.repository }}/commit/${sha}) ${etc}"
;;
"")
;;
*)
if test -n "${commit}"
then
- problems+=("" "--- ${commitText}")
+ problems+=("1) --- ${commitTextmd}")
echo ""
echo "--- ${commitText}"
commit=
fi
- problems+=("${dash} ${sha} ${etc}")
- echo "${problems[-1]}"
+ case "${dash}" in
+ *:[1-9]*:) # contains file and line number information
+ dashend=${dash#*:}
+ problems+=("[${dash}](https://github.com/${{ github.repository }}/blob/${{github.event.pull_request.head.ref}}/${dash%%:*}#L${dashend%:}) ${sha} ${etc}")
+ ;;
+ *)
+ problems+=("\`${dash} ${sha} ${etc}\`")
+ ;;
+ esac
+ echo "${dash} ${sha} ${etc}"
;;
esac
- done <<< $(git log --check --pretty=format:"---% h% s" ${{github.event.pull_request.base.sha}}..)
+ done <<< $(git log --check --pretty=format:"---% h% s" ${baseSha}..)
if test ${#problems[*]} -gt 0
then
if test -z "${commit}"
then
- lastcommit=${{github.event.pull_request.base.sha}}
+ goodparent=${baseSha: 0:7}
fi
- echo "A whitespace issue was found in one or more of the commits." >$GITHUB_STEP_SUMMARY
+ echo "🛑 Please review the Summary output for further information."
+ echo "### :x: 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
+ echo "Run these commands to correct the problem:" >>$GITHUB_STEP_SUMMARY
+ echo "1. \`git rebase --whitespace=fix ${goodparent}\`" >>$GITHUB_STEP_SUMMARY
+ echo "1. \`git push --force\`" >>$GITHUB_STEP_SUMMARY
+ echo " " >>$GITHUB_STEP_SUMMARY
+ echo "Errors:" >>$GITHUB_STEP_SUMMARY
for i in "${problems[@]}"
do
echo "${i}" >>$GITHUB_STEP_SUMMARY
--
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 ` [PATCH 1/2] Make `check-whitespace` " Chris. Webster via GitGitGadget
2022-12-16 10:06 ` 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 ` Chris. Webster via GitGitGadget [this message]
2022-12-16 10:13 ` [PATCH 2/2] Improve check-whitespace output 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=cdc2b1aae81f8c37b4e71cb3e0e382cf82de2272.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).