Split CI jobs into more steps for clearer output #32
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
The main benefit (and motivation for this change) is from splitting the old "Run Tests" step into an "Install project and dependencies" step, followed by a "Run Tests" step. With the new "Run Tests" step, it's easy to see the pytest output in the GitHub interface for a run. Expanding that step shows all, and only, the actual test output. This allows the CI output itself to be as readily usable as the output of running "pytest" interactively. (Of course, the uploaded artifacts remain useful and are still being generated.) This also has the benefit of greater accuracy. For example, when looking for where we install dependencies, someone unfamiliar with the workflows would not necessarily know to look in "Run Tests".
This makes test-package.yml use the same style as publish-package.yml.
# for free
to join this conversation on GitHub.
Already have an account?
# 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 leaves the logic and sequence of operations on CI the same, but makes them more granular so that it is easier to understand their output in the GitHub web interface.
The main benefit is from splitting the old "Run Tests" step into an "Install project and dependencies" step followed by a "Run Tests" step. I noticed that having them together made it hard to read the
pytestoutput because it was necessary to scroll down past copiouspoetry installoutput to find it, instead of just expanding a step. Having "Install project and its dependencies" be its own step before "Run Tests" fixes this, so that expanding "Run Tests" shows all, and only, the actual test output:This allows the CI output itself to be as readily usable as the output of running "pytest" interactively. (Of course, the uploaded artifacts are still useful; this does not stop generating those.)
This has a secondary benefit of greater descriptive accuracy. For example, when looking for where we install dependencies, someone unfamiliar with the workflows would not necessarily know to look in "Run Tests".