HL7 / ig-template-base

Base IG template managed by HL7 but usable by anyone (no logos). The foundation for most HL7-published IGs
14 stars 27 forks source link

Add a fragment with status of last build #219

Open costateixeira opened 1 year ago

costateixeira commented 1 year ago

When looking at an IG, we know it's built ok but we have no idea if the last build failed. Can we add a fragment that templates can optionally display - next to the publish box? - and show something like "This spec is up to date" or "The last build failed"... (text tbd)

lmckenzi commented 1 year ago

How could the current build possibly know that the last build failed?

costateixeira commented 1 year ago

checking the presense of e.g. http://build.fhir.org/ig/WorldHealthOrganization/smart-anc/failure/build.log or something?

grahamegrieve commented 1 year ago

The template can't add a fragment, so this is in the wrong place

grahamegrieve commented 1 year ago

Also, I don't understand how this is useful. if this build succeeds, why does it matter whether the last build failed?

costateixeira commented 1 year ago

The scenario where this is useful is when the build does not succeed - the current page (previous build) should show this somehow

lmckenzi commented 1 year ago

First, don't have a clue how the 'somehow' would work Second, who would care about this other than the person who's making changes - who can always monitor the Zulip stream.

costateixeira commented 1 year ago

this change is precisely for when one of the people making changes does not check the Zulip stream for one change, or when they cannot fix it, or for non-committers to see the status. If the build gets broken, non-committers will be looking at a broken build without knowing, and the next committers may presume it's their commit that breaks things.

lmckenzi commented 1 year ago

If you have multiple committers, then you might want to look at putting in merge blocking that prevents unsuccessful commits from merging to the master. Non-committers won't be looking at a broken build - they'll be looking at the last successful build. They'll have no idea there are pending changes they don't yet see, and that's probably fine. That's what a CI-build is...