Skip to content

chore: formatting#3655

Merged
ramonpetgrave64 merged 3 commits intoslsa-framework:mainfrom
ianlewis:make-format
May 17, 2024
Merged

chore: formatting#3655
ramonpetgrave64 merged 3 commits intoslsa-framework:mainfrom
ianlewis:make-format

Conversation

@ianlewis
Copy link
Member

@ianlewis ianlewis commented May 15, 2024

Summary

Formatted code in the repository. This is the result of running make format.

Testing Process

N/A

Checklist

  • Review the contributing guidelines
  • Add a reference to related issues in the PR description.
  • Update documentation if applicable.
  • Add unit tests if applicable.
  • Add changes to the CHANGELOG if applicable.

ianlewis added 2 commits May 15, 2024 23:27
Signed-off-by: Ian Lewis <ianlewis@google.com>
Signed-off-by: Ian Lewis <ianlewis@google.com>
@ianlewis ianlewis marked this pull request as ready for review May 15, 2024 23:48
@ramonpetgrave64 ramonpetgrave64 enabled auto-merge (squash) May 16, 2024 18:25
@ramonpetgrave64 ramonpetgrave64 merged commit a14d810 into slsa-framework:main May 17, 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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants