ci(check-whitespace): update stale file top comments

Commit Message

hakre Nov. 19, 2021, 6:50 p.m. UTC

From: hakre <[e-mail]>

Earlier a066a90d (ci(check-whitespace): restrict to the intended
commits, 2021-07-14) changed the check-whitespace task to stop using a
shallow clone, and cc003621 (ci(check-whitespace): stop requiring a
read/write token, 2021-07-14) changed the way how the errors the task
discovered is signaled back to the user.

They however forgot to update the comment that outlines what is done in
the task. Correct them.

Signed-off-by: Hans Krentel (hakre) <[e-mail]>
---
    ci(check-whitespace): update stale file top comments
    
    NOTE: In reference to
    https://lore.kernel.org/git/[e-mail]
    as GitGitGadget had hiccups this is an update via a new PR on Github.
    Sorry for this added noise, this one supersedes the earlier one.
    
    Please find the actual (updated) description following (thanks to all
    helping hands involved):
    
    Earlier a066a90d (ci(check-whitespace): restrict to the intended
    commits, 2021-07-14) changed the check-whitespace task to stop using a
    shallow clone, and cc003621 (ci(check-whitespace): stop requiring a
    read/write token, 2021-07-14) changed the way how the errors the task
    discovered is signaled back to the user.
    
    They however forgot to update the comment that outlines what is done in
    the task. Correct them.
    
    Signed-off-by: Hans Krentel (hakre) [e-mail]

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1143%2Fhakre%2Fpatch-1-gitgitgadget-vanilla-sky-technical-support-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1143/hakre/patch-1-gitgitgadget-vanilla-sky-technical-support-v1
Pull-Request: https://github.com/git/git/pull/1143

 .github/workflows/check-whitespace.yml | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)


base-commit: 5fbd2fc5997dfa4d4593a862fe729b1e7a89bcf8

Comments

Junio C Hamano Nov. 22, 2021, 7:05 a.m. UTC | #1

"hakre via GitGitGadget" <[e-mail]> writes:

> From: hakre <[e-mail]>
>
> Earlier a066a90d (ci(check-whitespace): restrict to the intended
> commits, 2021-07-14) changed the check-whitespace task to stop using a
> shallow clone, and cc003621 (ci(check-whitespace): stop requiring a
> read/write token, 2021-07-14) changed the way how the errors the task
> discovered is signaled back to the user.
>
> They however forgot to update the comment that outlines what is done in
> the task. Correct them.
>
> Signed-off-by: Hans Krentel (hakre) <[e-mail]>
> ---

I've manually corrected what is queued in my tree, but the name and
address recorded on the in-body From: line should match what is on
the signed-off-by line.  Please make sure I do not have to manually
fix your commits next time.

Thanks.

Patch

diff --git a/.github/workflows/check-whitespace.yml b/.github/workflows/check-whitespace.yml
index 8c4358d805c..ad3466ad16e 100644
--- a/.github/workflows/check-whitespace.yml
+++ b/.github/workflows/check-whitespace.yml
@@ -1,8 +1,9 @@ 
 name: check-whitespace
 
-# Get the repo with the commits(+1) in the series.
+# Get the repository with all commits to ensure that we can analyze
+# all of the commits contributed via the Pull Request.
 # Process `git log --check` output to extract just the check errors.
-# Add a comment to the pull request with the check errors.
+# Exit with failure upon white-space issues.
 
 on:
   pull_request: