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

Fix indentation (also tweak newlines/whitespace) in CI workflow yaml files #284

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

DeeDeeG
Copy link
Member

@DeeDeeG DeeDeeG commented Sep 13, 2024

tl;dr: Some whitespace-only tweaks to this repo's CI yaml worfklow files.

I kinda expect most people won't care about this, but @savetheclocktower might care about the first commit in this PR, at least.

First commit in this PR branch:

Fixes an off bit of indentation in one of the workflow .yaml files, per @savetheclocktower's comment pointing it out in this comment: d747eda#r146063988. (I think I may have run into this before and chosen to ignore it at the time, but feels better to me now to fix it after all.)

Second commit in this PR branch (optional, reviewers tell me whether you'd like this removed):

Also normalizes use of newlines in the workflow.yaml files: Always a blank line in-between steps, no matter what. Makes things more uniform, tidy and skimmable without missing things, IMO. Since they might not have appeared to be separate steps if not looked at closely. Makes the reader pause and consider that these are separate and distinct steps. Good for distracted troubleshooting, which is most troubleshooting, IMO.

Also, Pulsar automatically stripped some trailing spaces in the process... I committed these as well.

Note: Potential third commit?: (reviewers let me know if you're interested in this being added to the repo. can keep things tidy when reviewing commit histories. And help to not discourage formatting improvements for fear of "polluting the blame history.")

Can add this as a .git-blame-ignore-revs file to keep the blame view clean and ignore these commits when trying to suss out what actually went wrong with these files in the future, if anything:

.git-blame-ignore-revs file, click to expand):
### Run this command to always ignore formatting commits in `git blame` ###
###        git config blame.ignoreRevsFile .git-blame-ignore-revs       ###

# Thanks to this informative blog post for explaining the .git-blame-ignore-revs file: #
# https://www.stefanjudis.com/today-i-learned/how-to-exclude-commits-from-git-blame/   #
# The above note explaining how to activate it is copy-pasted from said blog post.     #



# Normalizing whitespace in the CI yml files
7080c53b05fe211c12fce2dac7fd976fb86ac3cb
35257b0ffb3e0c5faea64a4e032f6a9bf3c605ae

See blog post if curious about ignoring commits in git blame: https://www.stefanjudis.com/today-i-learned/how-to-exclude-commits-from-git-blame/ Also official git docs: https://git-scm.com/docs/git-blame#Documentation/git-blame.txt---ignore-revs-fileltfilegt Also GitHub.com will use such a file automatically: https://docs.github.com/en/repositories/working-with-files/using-files/viewing-a-file#ignore-commits-in-the-blame-view

Make the indentation here respect the usual two-space sized indenting
scheme.

Shout-out to savetheclocktower for noticing this.
Always put an empty line between workflow steps.

Get rid of stray trailing spaces at the ends of lines.
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