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

ci: init automated checks #16

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Conversation

johannes-lindgren
Copy link
Collaborator

@johannes-lindgren johannes-lindgren commented Aug 23, 2024

Resolves #14

Adding automated checks:

For the pull requests:

  • Title check: checks that the title it formatted according to the conventional commits specs. If we would like to ensure that all commit messages are formatted as such, we could configure the repository so that only squash and merge is allowed. In that way, the title from the PR will become the commit message.

For the source code:

  • Code formatting: note that this job will be failing in this PR. This is ok, since I'll address this in a separate PR.
  • Type checking
  • Linter
  • Tests
  • Build. Not very useful on its own, but the idea is that the output will be tested in another step (Test the build output #18). This will require a separate PR, which is why tha

@sep2 Once this PR has been merged, I'd like to request a branch protection rule for main that requires both of these checks to pass.

How to test

Create a new branch based on this one. Make changes, open a stacked PR, and observe the result from the automated checks:

Check that all jobs always run, even if the previous jobs failed. For example, if the code formatter fails, we still want to see if the linter fails.

@johannes-lindgren johannes-lindgren self-assigned this Aug 23, 2024
@johannes-lindgren johannes-lindgren changed the title ci: init GitHub workflows ci: GitHub action checks Aug 23, 2024
@johannes-lindgren johannes-lindgren changed the title ci: GitHub action checks ci: init automated checks Aug 26, 2024
@johannes-lindgren johannes-lindgren marked this pull request as ready for review August 26, 2024 21:48
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.

Automated checks
1 participant