Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: whitespace check #1726

Closed

Conversation

jltobler
Copy link

@jltobler jltobler commented May 1, 2024

Thanks for taking the time to contribute to Git! Please be advised that the
Git community does not use github.com for their contributions. Instead, we use
a mailing list (git@vger.kernel.org) for code submissions, code reviews, and
bug reports. Nevertheless, you can use GitGitGadget (https://gitgitgadget.github.io/)
to conveniently send your Pull Requests commits to our mailing list.

For a single-commit pull request, please leave the pull request description
empty
: your commit message itself should describe your changes.

Please read the "guidelines for contributing" linked above!

Sections of CI output defined by `begin_group()` and `end_group()` are
expanded in GitLab pipelines by default. This can make CI job output
rather noisy and harder to navigate. Update the behavior for GitLab
pipelines to now collapse sections by default.

Signed-off-by: Justin Tobler <jltobler@gmail.com>
Copy link

gitgitgadget bot commented May 1, 2024

There are issues in commit 1454be2:
github-ci: use generalized whitespace check
Commit checks stopped - the message is too short
Commit not signed off

@jltobler jltobler changed the title Jt/gitlab ci whitespace check CI Whitespace Check May 1, 2024
Copy link

gitgitgadget bot commented May 1, 2024

There are issues in commit 1454be2:
github-ci: use generalized whitespace check
Commit checks stopped - the message is too short
Commit not signed off

Copy link

gitgitgadget bot commented May 1, 2024

There are issues in commit 6559917:
add whitespace error
Commit checks stopped - the message is too short
Commit not signed off

@jltobler jltobler changed the title CI Whitespace Check ci: whitespace check May 1, 2024
@jltobler jltobler force-pushed the jt/gitlab-ci-whitespace-check branch from 6559917 to 8fc7b78 Compare May 1, 2024 22:34
Copy link

gitgitgadget bot commented May 1, 2024

There are issues in commit 2d73d79:
github-ci: use generalized whitespace check
Commit checks stopped - the message is too short
Commit not signed off

Copy link

gitgitgadget bot commented May 1, 2024

There are issues in commit 8fc7b78:
add whitespace
Commit checks stopped - the message is too short
Commit not signed off

@jltobler jltobler force-pushed the jt/gitlab-ci-whitespace-check branch from 8fc7b78 to 3cc0991 Compare May 1, 2024 22:43
Copy link

gitgitgadget bot commented May 1, 2024

There are issues in commit c844677:
github-ci: use generalized whitespace check
Commit checks stopped - the message is too short
Commit not signed off

Copy link

gitgitgadget bot commented May 1, 2024

There are issues in commit 3cc0991:
add whitespace
Commit checks stopped - the message is too short
Commit not signed off

@jltobler jltobler force-pushed the jt/gitlab-ci-whitespace-check branch from 3cc0991 to 345a848 Compare May 1, 2024 22:52
Copy link

gitgitgadget bot commented May 1, 2024

There are issues in commit 5b138b0:
github-ci: use generalized whitespace check
Commit checks stopped - the message is too short
Commit not signed off

Copy link

gitgitgadget bot commented May 1, 2024

There are issues in commit 345a848:
add whitespace
Commit checks stopped - the message is too short
Commit not signed off

@jltobler jltobler force-pushed the jt/gitlab-ci-whitespace-check branch from 345a848 to ff388e6 Compare May 1, 2024 23:01
Copy link

gitgitgadget bot commented May 1, 2024

There are issues in commit 60e65ab:
github-ci: use generalized whitespace check
Commit checks stopped - the message is too short
Commit not signed off

Copy link

gitgitgadget bot commented May 1, 2024

There are issues in commit ff388e6:
add whitespace
Commit checks stopped - the message is too short
Commit not signed off

@jltobler jltobler force-pushed the jt/gitlab-ci-whitespace-check branch from ff388e6 to bd93501 Compare May 1, 2024 23:05
Copy link

gitgitgadget bot commented May 1, 2024

There are issues in commit 93610eb:
github-ci: use generalized whitespace check
Commit checks stopped - the message is too short
Commit not signed off

Copy link

gitgitgadget bot commented May 1, 2024

There are issues in commit bd93501:
add whitespace
Commit checks stopped - the message is too short
Commit not signed off

@jltobler jltobler force-pushed the jt/gitlab-ci-whitespace-check branch from bd93501 to 4835903 Compare May 1, 2024 23:21
Copy link

gitgitgadget bot commented May 1, 2024

There are issues in commit 818783e:
github-ci: use generalized whitespace check
Commit checks stopped - the message is too short
Commit not signed off

Copy link

gitgitgadget bot commented May 1, 2024

There are issues in commit 4835903:
add whitespace
Commit checks stopped - the message is too short
Commit not signed off

@jltobler jltobler force-pushed the jt/gitlab-ci-whitespace-check branch from 4835903 to 1c43418 Compare May 2, 2024 16:16
Copy link

gitgitgadget bot commented May 2, 2024

There are issues in commit b0db38b:
add whitespace error
Commit checks stopped - the message is too short
Commit not signed off

1 similar comment
Copy link

gitgitgadget bot commented May 2, 2024

There are issues in commit b0db38b:
add whitespace error
Commit checks stopped - the message is too short
Commit not signed off

@jltobler jltobler force-pushed the jt/gitlab-ci-whitespace-check branch from b0db38b to d4ad9e4 Compare May 2, 2024 17:21
Copy link

gitgitgadget bot commented May 2, 2024

There are issues in commit d4ad9e4:
add whitespace error
Commit checks stopped - the message is too short
Commit not signed off

When the `check-whitespace` CI job detects whitespace errors, a
formatted summary of the issue is generated. This summary contains links
to the commits and blobs responsible for the whitespace errors. The
generated links for blobs do not work and result in a 404.

Instead of using the reference name in the link, use the commit ID
directly. This fixes the broken link and also helps enable future
generalization of the script for other CI providers by removing one of
the GitHub specific CI variables used.

Signed-off-by: Justin Tobler <jltobler@gmail.com>
@jltobler jltobler force-pushed the jt/gitlab-ci-whitespace-check branch from d4ad9e4 to a62e1bc Compare May 2, 2024 18:30
Copy link

gitgitgadget bot commented May 2, 2024

There are issues in commit a62e1bc:
add whitespace error for testing
Commit checks stopped - the message is too short
Commit not signed off

jltobler added 2 commits May 2, 2024 13:36
The `check-whitespace` CI job is only available as a GitHub action. To
help enable this job with other CI providers, first separate the logic
performing the whitespace check into its own script. In subsequent
commits, this script is further generalized allowing its reuse.

Helped-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Justin Tobler <jltobler@gmail.com>
The `check-whitespace` CI job generates a formatted output file
containing whitespace error information. As not all CI providers support
rendering a formatted summary, make its generation optional.

Signed-off-by: Justin Tobler <jltobler@gmail.com>
@jltobler jltobler force-pushed the jt/gitlab-ci-whitespace-check branch from a62e1bc to 4641ff2 Compare May 2, 2024 18:44
Copy link

gitgitgadget bot commented May 2, 2024

There are issues in commit 4641ff2:
add whitespace error for testing
Commit checks stopped - the message is too short
Commit not signed off

GitLab CI does not have a job to check for whitespace errors introduced
by a set of changes. Reuse the existing generic `whitespace-check.sh` to
create the job for GitLab pipelines.

Note that the `$CI_MERGE_REQUEST_TARGET_BRANCH_SHA` variable is only
available in GitLab merge request pipelines and therefore the CI job is
configured to only run as part of those pipelines.

Signed-off-by: Justin Tobler <jltobler@gmail.com>
@jltobler jltobler force-pushed the jt/gitlab-ci-whitespace-check branch from 4641ff2 to 175b300 Compare May 2, 2024 19:02
@jltobler jltobler closed this May 3, 2024
@dscho dscho mentioned this pull request May 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant