Stream: committers
Topic: Forthcoming Requirement for the CI-Build
Grahame Grieve (Aug 01 2019 at 22:53):
@all - from about 48 hours time, the CI build will no longer build an IG unless it has a publish box on every html page. The publish box is this fragment of html:
<!--ReleaseHeader--><p id=\"publish-box\">Publish Box goes here</p><!--EndReleaseHeader-->
This is the literal string required. There is no flexibility on this. It is up to the IG author how to style it, though fhir.css will automatically style it the way we usually style it.
The IG publisher will replace the string "Publish box goes here" with a status message appropriate for the CI-Build. The IG publisher also has functionality to manage the text in the html box when publishing
Grahame Grieve (Aug 01 2019 at 22:54):
if you have particular pages that you can argue should not have the publication status box on it, you are welcome to discuss with me
Grahame Grieve (Aug 01 2019 at 23:15):
Also, a reminder:
- only HL7 intl projects (or accelerator projects) can use the HL7 Logo. Affiliate projects should use the affiliate logo. Other projects should not use the HL7 logo.
- HL7, accelerator, and affiliate projects, and other SDOs with appropriate MoUs can use the FHIR logo. Any other projects require written trademark permission in order to do so
Grahame Grieve (Aug 01 2019 at 23:16):
I cannot technically enforce this right now in the build (or I would)
Josh Mandel (Aug 02 2019 at 17:57):
Can you clarify the rationale? (It will be disruption for all IG authors.) Would it be better just to have the ci web server frame all content with a message above the page?
Grahame Grieve (Aug 02 2019 at 20:26):
I don't know where 'above the page' is in the messy div based html that is generated.
Grahame Grieve (Aug 02 2019 at 20:27):
TSC requires all guides to show their status. All HL7 guides already do. I can:
- just stick the notice somewhere and mess things up
- just stick the notice over the top of everything and cover something over
- let the author say where it goes
Which would you rather?
Grahame Grieve (Aug 02 2019 at 22:10):
anyway, all IGs should have a clearly marked status message place for later publication management
Josh Mandel (Aug 04 2019 at 01:24):
Hmm. I was thinking about framing the guides rather than altering the contents of the guides themselves. Not sure it's a better idea; just trying to explore the trade-offs.
Josh Mandel (Aug 04 2019 at 01:24):
Is TSC aiming to apply these rules to all guides in the HL7 GitHub org, or all guides using build.fhir.org for CI, or something else?
Grahame Grieve (Aug 04 2019 at 03:14):
All guides using the computer build. I don’t think it’s unreasonable either
Josh Mandel (Aug 04 2019 at 18:28):
Okay -- so for non HL7 guides you'll add a message saying what (into this spot on each page)?
Grahame Grieve (Aug 04 2019 at 20:47):
currently it says, for HL7 projects:
[project-name] - CI build (v[version]). See the Directory of published versions
Grahame Grieve (Aug 04 2019 at 20:49):
I'm going to change this to something like:
[project-name], [publisher] project - CI build for v[version]. This version is based on the current content of [github-link] and changes regularly. See the Directory of published versions
Lloyd McKenzie (Aug 04 2019 at 20:56):
Why [publisher]?
Lloyd McKenzie (Aug 04 2019 at 20:56):
That's already reflected elsewhere
Grahame Grieve (Aug 04 2019 at 21:00):
where?
Josh Mandel (Aug 04 2019 at 21:40):
Okay -- so for non HL7 guides you'll add a message saying what (into this spot on each page)?
Grahame Grieve (Aug 04 2019 at 21:41):
that message above
Grahame Grieve (Aug 04 2019 at 22:02):
for non-HL7 guide authors reading this:
- you are required to have the publish box clearly visible at the top of each page somewhere when using the auto-build. You can style it how you like, but you can't hide it.
- you are not required to retain the publish box when you publish milestones elsewhere, though I recommend that you do make use of it to keep the users informed about status
Lloyd McKenzie (Aug 04 2019 at 22:22):
Publisher is required to be listed in the footer.
Grahame Grieve (Aug 04 2019 at 22:28):
For HL7 guides. This applies to all guides
Lloyd McKenzie (Aug 04 2019 at 22:41):
Ok, but if it's in HL7 guides and non-HL7 publications don't think it's worth putting in their footer, why force it to be in the header?
Grahame Grieve (Aug 04 2019 at 22:43):
because TSC policy - after a problem this week - is that anything built on the IG auto-build system must show who is publishing it clearly. And burying it at the bottom isn't clear enough
Jose Costa Teixeira (Aug 05 2019 at 08:03):
Where should this go? In the html exceprts (pagebeginhtml) or in each xhtml?
Lloyd McKenzie (Aug 05 2019 at 14:03):
pagebeginhtml is simplest
Jose Costa Teixeira (Aug 28 2019 at 18:33):
@Lloyd McKenzie I need help with this. I added it here, but I still get a few of these
[java] Internal error in location for message: 'Error in ?? at 1, 1: Premature ExpressionNode termination at unexpected token ":"', loc = 'C:\HL7\IGs\hl7-be\be-core-ig\output\artifacts.html', err = 'The html source does not contain the publish box <!--ReleaseHeader--><p id="publish-box">Publish Box'
Jose Costa Teixeira (Aug 28 2019 at 18:33):
does it mean that also the xslts have to get that excerpt?
Lloyd McKenzie (Aug 28 2019 at 18:34):
Digging into it myself
Jose Costa Teixeira (Aug 28 2019 at 18:37):
thanks
Grahame Grieve (Aug 28 2019 at 19:23):
hmm I thought I hunted all that down
Grahame Grieve (Aug 28 2019 at 19:24):
it's an internal thing - checking that the OperationOutcomes are valid.
Brian Reinhold (Sep 19 2019 at 14:03):
for non-HL7 guide authors reading this:
- you are required to have the publish box clearly visible at the top of each page somewhere when using the auto-build. You can style it how you like, but you can't hide it.
- you are not required to retain the publish box when you publish milestones elsewhere, though I recommend that you do make use of it to keep the users informed about status
What should I do if my pages are markdown?
Rob Hausam (Sep 19 2019 at 14:16):
You can add the necessary html in a markdown page.
Grahame Grieve (Sep 19 2019 at 14:17):
your templates will be in html, and that's where you add it
Rob Hausam (Sep 19 2019 at 14:23):
yes, agree
Last updated: Apr 12 2022 at 19:14 UTC
