basic foundation CI setup

seL4 / microkit

Microkit - A simple operating system framework for the seL4 microkernel

Other

70 stars 37 forks source link

basic foundation CI setup #54

Closed lsf37 closed 9 months ago

lsf37 commented 9 months ago

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.

Ivan-Velickovic commented 9 months ago

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 commented 9 months ago

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 commented 9 months ago

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).