Add status badges in README.md #968
Open
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 script scans through git submodules in the superproject and generates a table with CI status badges as well as other relevant links for all the submodules. Multiple tables can be created for different git branches. The script inserts the generated content between two marker Markdown comments in README.md, removing any previous content between them. This allows the script to be simply rerun to update the list of submodules. This commit also updates README.md with the generated tables for master and develop.
Lastique
force-pushed
the
feature/add_ci_badges
branch
from
a8469d9 to
84ed5d8
Compare
|
Any comments? It might be a good time for a tool like this since 1.87 release is preparing. |
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 adds a new script
status/update_status_badges.py. The script scans through git submodules in the superproject and generates a table with CI status badges as well as other relevant links for all the submodules. Multiple tables can be created for different git branches.The script inserts the generated content between two marker Markdown comments in
README.md, removing any previous content between them. This allows the script to be simply rerun to update the list of submodules.This PR also adds the generated tables with CI badges for master and develop in
README.md. You may view the result here.The intended workflow is to run
status/update_status_badges.pyperiodically when new git submodules are added or removed from the superproject, or the CI badges are added or removed in the submodules. It might be a good idea to run the script every once in a while (e.g. before a new Boost release preparation starts) to make sure the badges are up to date. Note that you do not need to run this script to update badge statuses (i.e. whether the CIs are passing or failing). This happens automatically as this information is pulled from CI via the badge image URLs.I believe, this information could be useful to Boost release managers (@mclow, @glenfe, @igaztanaga) in order to monitor overall Boost health during the release preparation. This is specifically useful for monitoring libraries that are not actively maintained, as it sometimes happens that breakages that are visible on CI are not noticed by anyone until after the release.
I'm also open to suggestions on how this can be improved to be more useful. Also please let me know if this is not useful at all and not worth the effort.