CI: streamline and add build and codespell targets #74
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
1 task
hnez
force-pushed
the
ci-streamline
branch
2 times, most recently
from
8965a52 to
6c183cf
Compare
This does not have any immediate benefits but allows us to add build and publish stages later, that depends on all the qa steps to complete successfully. Signed-off-by: Leonard Göhrs <[email protected]>
This makes sure we always use the exact version we have installed and not e.g. another version installed for another python version. Signed-off-by: Leonard Göhrs <[email protected]>
The environment is already used for more quality assurance tasks than just running pytest tests, making QA a more fitting name. Signed-off-by: Leonard Göhrs <[email protected]>
In make .PHONY targets are targets that do not generate a file/directory/filesystem object with the same name as the rule. This applies to most of our rules. Signed-off-by: Leonard Göhrs <[email protected]>
This allows calling individual qa tests interactively via e.g.: $ make qa-pytest while still being able to run all of them via: $ make qa Signed-off-by: Leonard Göhrs <[email protected]>
This both simplifies our CI pipeline and also makes it so that the local checks match the rules run in the CI are exactly the same. Signed-off-by: Leonard Göhrs <[email protected]>
This will allow us to have a publish job later on that uses the built artifacts and publishes them on pypi.org. Signed-off-by: Leonard Göhrs <[email protected]>
Codespell has proven useful in other projects, so lets use it here as well. Signed-off-by: Leonard Göhrs <[email protected]>
Signed-off-by: Leonard Göhrs <[email protected]>
Signed-off-by: Leonard Göhrs <[email protected]>
SmithChart
approved these changes
May 6, 2024
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 brings the CI closer to our current best practice, as seen in usbmuxctl and lxa-iobus.
What we consider best practice is obviously always in a state of flux, but right now it means having auto-formatting and linting (we already had that) as well as codespell for typo-catching and a build job to make sure the build process works and so we have CI-built artifacts.
TODO before merging: