style: Run shfmt on workflows, actions and markdown bash code - #7333
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds tooling to format embedded bash snippets consistently with the repository’s shfmt pre-commit configuration, then applies the resulting formatting to workflows, actions, and markdown examples.
Changes:
- Adds
.github/scripts/format-inline-bash.pyand two local pre-commit hooks for workflow/actionrun:blocks and markdown bash fences. - Applies
shfmt-style indentation and redirection spacing to GitHub workflow/action shell snippets. - Updates markdown bash examples and retags one non-shell error block as
text.
Reviewed changes
Copilot reviewed 5 out of 18 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
.github/scripts/format-inline-bash.py |
New formatter for embedded workflow/action and markdown shell snippets. |
.pre-commit-config.yaml |
Registers local hooks for inline bash formatting. |
.github/actions/build-deps/action.yml |
Applies shell formatting to Conan install command. |
.github/actions/generate-version/action.yml |
Applies shell formatting to version generation steps. |
.github/workflows/build-nix-image.yml |
Applies shell formatting to manifest loop. |
.github/workflows/check-pr-description.yml |
Formats inline and multiline PR-description check commands. |
.github/workflows/on-pr.yml |
Applies shell formatting to output and gh api commands. |
.github/workflows/reusable-build-docker-image.yml |
Applies shell formatting to Docker metadata output. |
.github/workflows/reusable-build-test-config.yml |
Applies shell formatting throughout build/test workflow steps. |
.github/workflows/reusable-check-levelization.yml |
Applies shell indentation formatting. |
.github/workflows/reusable-check-rename.yml |
Applies shell indentation formatting. |
.github/workflows/reusable-clang-tidy.yml |
Applies shell formatting to clang-tidy workflow steps. |
.github/workflows/reusable-package.yml |
Applies shell formatting to package matrix generation. |
.github/workflows/reusable-strategy-matrix.yml |
Applies shell formatting to matrix output redirection. |
BUILD.md |
Formats bash snippet and retags non-shell error output as text. |
include/xrpl/protocol_autogen/README.md |
Formats bash command comments. |
package/README.md |
Formats bash examples for package builds. |
cspell.config.yaml |
Adds dedented to accepted words for the new script docstring. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
bthomee
reviewed
May 27, 2026
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #7333 +/- ##
=======================================
Coverage 82.4% 82.4%
=======================================
Files 1011 1011
Lines 76477 76477
Branches 7319 7315 -4
=======================================
+ Hits 62990 62999 +9
+ Misses 13487 13478 -9 🚀 New features to boost your workflow:
|
bthomee
approved these changes
May 27, 2026
bthomee
enabled auto-merge
May 27, 2026 17:26
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
High Level Overview of Change
This extracts inline bash in mentioned files, formats it and puts it back.
More code gets formatted uniformely.
I suggest not spending too much time on the script - it's AI-coded, and seems to work.
There is not much purpose of making it nice.
Context of Change
API Impact
libxrplchange (any change that may affectlibxrplor dependents oflibxrpl)