Improve job names for the build workflow in GitHub Actions
#120
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
mcdonnnj
added
improvement
jsf9k
approved these changes
Feb 5, 2023
mcdonnnj
added
the
kraken 🐙
Sort all pre-`steps` keys alphabetically descending. Sorting all keys alphabetically would be somewhat onerous because the `strategy` key would come after the `steps` key even though it's configuration information. We can at least sort everything but the `steps` key in alphabetically descending order and make the `steps` the last for a job.
Add `name` keys to the `test`, `build`, and `test-build` jobs that are both more descriptive and include the Python version from the job's matrix. This will produce consistent and more helpful job names in the GitHub Actions log in the GitHub web UI.
mcdonnnj
force-pushed
the
improvement/update_names_for_jobs_using_matrix_strategy
branch
from
236f5f6
to
0f3dd39
Compare
jmorrowomni
deleted the
improvement/update_names_for_jobs_using_matrix_strategy
branch
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.
🗣 Description
This pull request improves the names for the
test,build, andtest-buildjobs as displayed in the GitHub web UI. It also sorts all pre-stepskeys in a job in descending alphabetical order.💭 Motivation and context
The key sorting is adjusted to stick as reasonably close to our preference to sort all YAML map keys in alphabetically descending order. Since the
stepskey is the meat of the job and everything else is configuration it makes sense to have thestepskey last and sort everything preceding it in descending alphabetical order.The job names are updates to both be more descriptive and with the modifications that were required to continue supporting Python 3.6 to make them prettier compared to the auto-generated name using the matrix values.
🧪 Testing
Automated tests pass. You can see the now ✨fabulous✨ output in this run log.
✅ Pre-approval checklist