Add shell script to generate build status for READMEs #258
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #258 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 2 2
Lines 22 22
Branches 10 10
=========================================
Hits 22 22 Continue to review full report in Codecov by Sentry.
|
There was a problem hiding this comment.
I guess this is more general than what we have here in https://github.com/boostorg/boost-ci/blob/master/README.template.md
The idea there was to be able to use the whole readme with a simple search&replace.
Can you use this script to update the template and the main readme of this repo in this PR? The would fix the outdated current readme-badges and IMO makes for a good verification of the script.
|
|
||
| ARGS=$(getopt --longoptions "project:,appveyor:,codecov:,coverity:" "p:a:v:y:" -- "$@") | ||
|
|
||
| if [ $? != 0 ] ; then echo "Terminating..." >&2 ; exit 1 ; fi |
There was a problem hiding this comment.
Can we have some help text what the options are supposed to be?
| case "${1:-*}" in | ||
| -p | --project) PROJECT="$2"; shift 2 ;; | ||
| -a | --appveyor) APPVEYOR="$2"; shift 2 ;; | ||
| -v | --codecov) CODECOV="$2"; shift 2 ;; |
There was a problem hiding this comment.
Especially for this we need to have a comment/help text which token is required here. I fear that some might leak their secret token if it isn't clear what this is.
| while true; do | ||
| case "${1:-*}" in | ||
| -p | --project) PROJECT="$2"; shift 2 ;; | ||
| -a | --appveyor) APPVEYOR="$2"; shift 2 ;; |
There was a problem hiding this comment.
This doesn't seem to be enough. For Boost.CI:
[](https://ci.appveyor.com/project/Flamefire/boost-ci/branch/master)
So we need both the appveyor project owner and that hash/id-thing
| COVERITY= | ||
|
|
||
| while true; do | ||
| case "${1:-*}" in |
There was a problem hiding this comment.
The default of * looks odd, I'd use an empty value. But as any value works this is fine.
This script helps generate the badge table in README files of many boostorg repos, for example CMT maintained repos.