Stream: IG creation
Topic: github badges
Jose Costa Teixeira (Apr 06 2022 at 17:35):
I'm thinking of adding github badges to some IGs.
Jose Costa Teixeira (Apr 06 2022 at 17:35):
Reason: sometimes we do commits after a successful build but things are broken somehow. And it is now difficult to see this (we can monitor the committers/notification stream, but that also doesn't work for IGs that are built with github actions.)
Jose Costa Teixeira (Apr 06 2022 at 17:35):
I'd go for some standard badges, comme il faut :)
build status + issues
Jose Costa Teixeira (Apr 06 2022 at 17:36):
like this
https://github.com/costateixeira/mynewig#readme
Jose Costa Teixeira (Apr 06 2022 at 17:37):
I'm looking for feedback on:
- is this of interest to anyone else?
Jose Costa Teixeira (Apr 06 2022 at 17:38):
- what badges do we want to have? I'd think of:
- github issues (if we use them),
- QA warnings
- QA errors
- ... ?
João Almeida (Apr 06 2022 at 17:42):
great idea. Some badges could be more regarding resources (like nr profiles, nr of logical models, and so on)
Others could be for automatic testing (if available)
Just thinking out loud though
John Moehrke (Apr 06 2022 at 17:49):
seems interesting, not sure how effective it will be.. but not possible to evaluate effectiveness without someone going first.
Lloyd McKenzie (Apr 06 2022 at 18:09):
If the build isn't running, there won't be a build. For HL7 IGs, there should never be Git issues. The QA stuff shows up in the QA report. So I'm not really clear on what this would be for...
John Moehrke (Apr 06 2022 at 18:13):
so in the HL7 case the issues count should come from jira. Others are using github issues, so it is useful pattern.
John Moehrke (Apr 06 2022 at 18:14):
I was not expecting that Jose was showing a fully fleshed system, but rather proposing we consider developing these kind of patterns for IG github repos. right?
Jose Costa Teixeira (Apr 06 2022 at 18:32):
If the build is on GitHub actions, the badges can show it fails
Jose Costa Teixeira (Apr 06 2022 at 18:33):
GitHub issues is a standard badge, but we should be able to get Jira issues (should be a get call + some parsing)
Jose Costa Teixeira (Apr 06 2022 at 18:36):
And yes, @John Moehrke I wanti to see what patterns (i.e. what data do we want to show on badges) we are interested in.
Jose Costa Teixeira (Apr 06 2022 at 18:37):
If we have a few standard ones, we can automatically create them without the user needing to do anything besides using the magic keywords
Lloyd McKenzie (Apr 06 2022 at 18:38):
I see zero use for it, but I don't object to it. I would never look at the Git website for a given IG unless I needed to change configuration or do some weird merge or something.
John Moehrke (Apr 06 2022 at 18:40):
that was my initial reaction. I am not sure who audience is for github readme vs the actual publication (public) or ci-build (commitee)
Jose Costa Teixeira (Apr 06 2022 at 19:09):
GitHub readme is for committers who want to have some insight. At this moment there's no alternative, afaik
Jose Costa Teixeira (Apr 06 2022 at 19:10):
Ci-build doesn't say "this is no longer reflecting the current content or build status because this repo is no longer building"
Lloyd McKenzie (Apr 06 2022 at 19:28):
No, but committers/announce does. As does the IG builds page.
Lloyd McKenzie (Apr 06 2022 at 19:28):
And both of those give you access to the logs indicating the issues
Last updated: Apr 12 2022 at 19:14 UTC
