mirror of
https://github.com/git/git
synced 2024-06-30 22:54:27 +00:00
Merge branch 'jt/port-ci-whitespace-check-to-gitlab'
The "whitespace check" task that was enabled for GitHub Actions CI has been ported to GitLab CI. * jt/port-ci-whitespace-check-to-gitlab: gitlab-ci: add whitespace error check ci: make the whitespace report optional ci: separate whitespace check script github-ci: fix link to whitespace error ci: pre-collapse GitLab CI sections
This commit is contained in:
commit
3fc99d037f
67
.github/workflows/check-whitespace.yml
vendored
67
.github/workflows/check-whitespace.yml
vendored
|
@ -26,66 +26,7 @@ jobs:
|
|||
- name: git log --check
|
||||
id: check_out
|
||||
run: |
|
||||
baseSha=${{github.event.pull_request.base.sha}}
|
||||
problems=()
|
||||
commit=
|
||||
commitText=
|
||||
commitTextmd=
|
||||
goodparent=
|
||||
while read dash sha etc
|
||||
do
|
||||
case "${dash}" in
|
||||
"---")
|
||||
if test -z "${commit}"
|
||||
then
|
||||
goodparent=${sha}
|
||||
fi
|
||||
commit="${sha}"
|
||||
commitText="${sha} ${etc}"
|
||||
commitTextmd="[${sha}](https://github.com/${{ github.repository }}/commit/${sha}) ${etc}"
|
||||
;;
|
||||
"")
|
||||
;;
|
||||
*)
|
||||
if test -n "${commit}"
|
||||
then
|
||||
problems+=("1) --- ${commitTextmd}")
|
||||
echo ""
|
||||
echo "--- ${commitText}"
|
||||
commit=
|
||||
fi
|
||||
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" ${baseSha}..)
|
||||
|
||||
if test ${#problems[*]} -gt 0
|
||||
then
|
||||
if test -z "${commit}"
|
||||
then
|
||||
goodparent=${baseSha: 0:7}
|
||||
fi
|
||||
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 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
|
||||
done
|
||||
|
||||
exit 2
|
||||
fi
|
||||
./ci/check-whitespace.sh \
|
||||
"${{github.event.pull_request.base.sha}}" \
|
||||
"$GITHUB_STEP_SUMMARY" \
|
||||
"https://github.com/${{github.repository}}"
|
||||
|
|
|
@ -113,3 +113,12 @@ static-analysis:
|
|||
script:
|
||||
- ./ci/run-static-analysis.sh
|
||||
- ./ci/check-directional-formatting.bash
|
||||
|
||||
check-whitespace:
|
||||
image: ubuntu:latest
|
||||
before_script:
|
||||
- ./ci/install-dependencies.sh
|
||||
script:
|
||||
- ./ci/check-whitespace.sh "$CI_MERGE_REQUEST_TARGET_BRANCH_SHA"
|
||||
rules:
|
||||
- if: $CI_PIPELINE_SOURCE == 'merge_request_event'
|
||||
|
|
95
ci/check-whitespace.sh
Executable file
95
ci/check-whitespace.sh
Executable file
|
@ -0,0 +1,95 @@
|
|||
#!/usr/bin/env bash
|
||||
#
|
||||
# Check that commits after a specified point do not contain new or modified
|
||||
# lines with whitespace errors. An optional formatted summary can be generated
|
||||
# by providing an output file path and url as additional arguments.
|
||||
#
|
||||
|
||||
baseCommit=$1
|
||||
outputFile=$2
|
||||
url=$3
|
||||
|
||||
if test "$#" -ne 1 && test "$#" -ne 3
|
||||
then
|
||||
echo "USAGE: $0 <BASE_COMMIT> [<OUTPUT_FILE> <URL>]"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
problems=()
|
||||
commit=
|
||||
commitText=
|
||||
commitTextmd=
|
||||
goodParent=
|
||||
|
||||
while read dash sha etc
|
||||
do
|
||||
case "${dash}" in
|
||||
"---") # Line contains commit information.
|
||||
if test -z "${goodParent}"
|
||||
then
|
||||
# Assume the commit has no whitespace errors until detected otherwise.
|
||||
goodParent=${sha}
|
||||
fi
|
||||
|
||||
commit="${sha}"
|
||||
commitText="${sha} ${etc}"
|
||||
commitTextmd="[${sha}](${url}/commit/${sha}) ${etc}"
|
||||
;;
|
||||
"")
|
||||
;;
|
||||
*) # Line contains whitespace error information for current commit.
|
||||
if test -n "${goodParent}"
|
||||
then
|
||||
problems+=("1) --- ${commitTextmd}")
|
||||
echo ""
|
||||
echo "--- ${commitText}"
|
||||
goodParent=
|
||||
fi
|
||||
|
||||
case "${dash}" in
|
||||
*:[1-9]*:) # contains file and line number information
|
||||
dashend=${dash#*:}
|
||||
problems+=("[${dash}](${url}/blob/${commit}/${dash%%:*}#L${dashend%:}) ${sha} ${etc}")
|
||||
;;
|
||||
*)
|
||||
problems+=("\`${dash} ${sha} ${etc}\`")
|
||||
;;
|
||||
esac
|
||||
echo "${dash} ${sha} ${etc}"
|
||||
;;
|
||||
esac
|
||||
done <<< "$(git log --check --pretty=format:"---% h% s" "${baseCommit}"..)"
|
||||
|
||||
if test ${#problems[*]} -gt 0
|
||||
then
|
||||
if test -z "${goodParent}"
|
||||
then
|
||||
goodParent=${baseCommit: 0:7}
|
||||
fi
|
||||
|
||||
echo "A whitespace issue was found in onen of more of the commits."
|
||||
echo "Run the following command to resolve whitespace issues:"
|
||||
echo "git rebase --whitespace=fix ${goodParent}"
|
||||
|
||||
# If target output file is provided, write formatted output.
|
||||
if test -n "$outputFile"
|
||||
then
|
||||
echo "🛑 Please review the Summary output for further information."
|
||||
(
|
||||
echo "### :x: A whitespace issue was found in one or more of the commits."
|
||||
echo ""
|
||||
echo "Run these commands to correct the problem:"
|
||||
echo "1. \`git rebase --whitespace=fix ${goodParent}\`"
|
||||
echo "1. \`git push --force\`"
|
||||
echo ""
|
||||
echo "Errors:"
|
||||
|
||||
for i in "${problems[@]}"
|
||||
do
|
||||
echo "${i}"
|
||||
done
|
||||
) >"$outputFile"
|
||||
fi
|
||||
|
||||
exit 2
|
||||
fi
|
|
@ -18,7 +18,7 @@ elif test true = "$GITLAB_CI"
|
|||
then
|
||||
begin_group () {
|
||||
need_to_end_group=t
|
||||
printf "\e[0Ksection_start:$(date +%s):$(echo "$1" | tr ' ' _)\r\e[0K$1\n"
|
||||
printf "\e[0Ksection_start:$(date +%s):$(echo "$1" | tr ' ' _)[collapsed=true]\r\e[0K$1\n"
|
||||
trap "end_group '$1'" EXIT
|
||||
set -x
|
||||
}
|
||||
|
|
Loading…
Reference in New Issue
Block a user