chore: formatting #3655
Merged
chore: formatting #3655
Conversation
This file contains 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
Signed-off-by: Ian Lewis <ianlewis@google.com>
ianlewis
requested review from
laurentsimon,
joshuagl,
kpk47 and
ramonpetgrave64
as code owners
5 tasks
ramonpetgrave64
approved these changes
May 16, 2024
ianlewis
added a commit
that referenced
this pull request
Jun 6, 2024
# Summary Adds a formatting pre-submit check that runs `make format` and checks for file differences. The results of running `make format` are not included in this PR for readability. So the pre-submit will depend on #3655 and probably some more formatting before the check will pass. Added a `make shfmt` formatting check for bash scripts. `autogen` (for adding license headers) is now vendored in the `third_party` directory for convenience sake. `markdown-toc` and `autogen` are now run by `make format`. The formatting pre-submit now runs these as well so they don't have separate pre-submit jobs. We will need to adjust the required checks on branch protection to remove "markdown-toc" and "autogen" jobs, and also add the "formatting" job. `CONTRIBUTING.md` was updated to include some more information about coding style and conventions. ## Testing Process 1. Run `make format` 2. Verify the formatting results ## Checklist - [x] Review the contributing [guidelines](https://github.com/slsa-framework/slsa-github-generator/blob/main/CONTRIBUTING.md) - [x] Add a reference to related issues in the PR description. - [x] Update documentation if applicable. - [x] Add unit tests if applicable. - [x] Add changes to the [CHANGELOG](https://github.com/slsa-framework/slsa-github-generator/blob/main/CHANGELOG.md) if applicable. --------- Signed-off-by: Ian Lewis <ianlewis@google.com>
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.
Summary
Formatted code in the repository. This is the result of running
make format.Testing Process
N/A
Checklist