-
Notifications
You must be signed in to change notification settings - Fork 6
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
Implement CI for pull requests #26
Merged
Merged
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
To clarify:
|
4e4a304
to
91e65c4
Compare
After rebasing the branch everything now passes except Review PR, which fails due to workflow not having enough permissions because its not merged yet and just a PR. Everything should be fine after merging. |
artob
approved these changes
Dec 4, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
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.
This PR implements a CI workflow which is executed every time a PR is open, reopened or new commits are pushed.
The workflow will checkout HEAD of a pull request branch, and first things first check if formatting is correct.
Then it will run next steps:
These all steps could be running on any OS (Linux, macOS, Windows), but since we don't have any cross-platform code right now, I've only left Linux.
If all of the steps succeed, github-actions bot will approve the PR.
If any of steps fail, github-actions bot will request changes and provide a meaningful information about steps that were ran.
All the formatting done using rustfmt from the latest stable Rust toolchain release.
All the building and running tests done using Rust version 1.81.0, which is our current MSRV.
This CI will run on every commit even for a draft PR. It is intended behavior. If you feel like it should be changed please do let me know.
Just like any other CI it can be skipped including
[skip ci]
or anything similar in commit message.Here is an example of a failed output:

As you can see above, I print all the steps performed, even if they were successful.

There is also available a "non-verbose" mode as I call it which can be switched very easily in the code (if you prefer it over verbose), which will only show failed steps, like this:
And this is how a verbose mode looks for 3 platforms:

For more examples you can look here.