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

basic foundation CI setup #54

Merged
merged 2 commits into from
Sep 13, 2023
Merged

basic foundation CI setup #54

merged 2 commits into from
Sep 13, 2023

Conversation

lsf37
Copy link
Member

@lsf37 lsf37 commented Sep 13, 2023

This PR adds the basic standard checks for foundation repos:

  • licenses
  • trailing whitespace
  • gitlint
  • code style
  • portable shell check
  • link check (for links in .md and .html files)

It also adds missing license headers and texts so that the licence check can succeed on new pull requests.

The style check is likely to fail initially if the repo hasn't used the same astyle config before. We can leave that check as optional for a while of that leads to friction.

These are: gitlint, trailing whitespace check, portable shell check,
style check, license check, and link check

Signed-off-by: Gerwin Klein <[email protected]>
@Ivan-Velickovic
Copy link
Collaborator

Only comment I have is that somewhere in the repository, it should show you how to run the checks yourself. E.g a README in .github

@Ivan-Velickovic
Copy link
Collaborator

For the CI tests I was going to add a ci directory, if we do that then the instructions for the style checks etc could also go there.

@lsf37
Copy link
Member Author

lsf37 commented Sep 13, 2023

For the CI tests I was going to add a ci directory, if we do that then the instructions for the style checks etc could also go there.

That's a good idea, and we should probably add general instructions on how to run those checks somewhere central as well (and maybe then link from here or something like that).

@lsf37 lsf37 merged commit f7ca9db into main Sep 13, 2023
@lsf37 lsf37 deleted the foundation-setup branch September 13, 2023 11:00
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