Stream: IG creation
Topic: Change to IG publisher
Grahame Grieve (Dec 07 2020 at 03:19):
This is advance notice of a forth coming change to the way the IG publisher works. At present, when you are actually preparing for an HL7 publication, you include a modified version of package-list.json in the root of the IG repository that has the new entry.
I'm going to replace this with a pub-request.json file, or similar, where you fill out the details of a proposed publication. This will be simpler and less prone to error. In addition, I'll be asking a few more questions about the proposed publication in the json template.
We're finding that it's really hard for editors to nail down the details of the publication request. There's checklists etc, but there's still lots of problems in what is being submitted. This change is part of trying to clean up the pipeline so that it's simpler over all for editors
Lloyd McKenzie (Dec 07 2020 at 03:40):
I presume this change is post-ballot?
Jose Costa Teixeira (Dec 07 2020 at 09:04):
I appreciate the change. Is this also for non-HL7 IGs?
Grahame Grieve (Dec 07 2020 at 09:27):
yes. this is not this year, but hopefully before the next ballot
Grahame Grieve (Dec 07 2020 at 09:27):
it'll be for anyone who uses the HL7 publishing framework
Grahame Grieve (Dec 07 2020 at 09:27):
which could include IHE if IHE wants
Jose Costa Teixeira (Dec 07 2020 at 09:39):
what is the "publishing framework"? processes, tools ,templates? infrastructure?
Grahame Grieve (Dec 07 2020 at 09:56):
well, all the part after 'here's a built IG' to 'here's a maintained web site'
Jose Costa Teixeira (Dec 07 2020 at 10:26):
then I think IHE will be interested indeed. Same for affiliates and other initiatives such as our federal government.
Jens Villadsen (Feb 03 2021 at 08:09):
@Grahame Grieve how would this affect the way that the affiliates are using the publisher. In my own experience, the proces is quite different from how HL7 International does it.
Grahame Grieve (Feb 03 2021 at 20:09):
well, to my knowledge, the affiliates are not using this part of the process at all, so it won't make any difference
Jose Costa Teixeira (Feb 03 2021 at 20:13):
There's at least one affiliate looking to get this publication (milestones) going.
Grahame Grieve (Feb 03 2021 at 20:21):
then it will affect them too
Oliver Egger (Feb 03 2021 at 21:29):
we use the IG Publisher to publish on fhir.ch for swiss ig's and I would offer to test the changes as soon as they are ready in the publisher.
John Moehrke (Feb 03 2021 at 21:37):
I haven't looked at the impact, but would be interest in assessing the impact on IHE use of the IG build tooling.
Jose Costa Teixeira (Feb 03 2021 at 22:49):
IHE was my first motivation for this, I expect that the results will apply (and will follow up when this happens)
Jose Costa Teixeira (Feb 04 2021 at 00:10):
Grahame Grieve said:
I'm going to replace this with a pub-request.json file, or similar, where you fill out the details of a proposed publication. This will be simpler and less prone to error. In addition, I'll be asking a few more questions about the proposed publication in the json template.
I parrticularly like this change.
Do you foresee that a publication request can be rolled back? (I presume, worst case, it can be a manual roll back - delete the entry in package-list.json,...)
Grahame Grieve (Feb 04 2021 at 00:19):
hadn't thought about that
Jens Villadsen (Feb 04 2021 at 11:23):
Grahame Grieve said:
well, to my knowledge, the affiliates are not using this part of the process at all, so it won't make any difference
So ... its a matter of a changing the manual working proces?
Myself, @Oliver Egger and perhaps @Jose Costa Teixeira have breifly discussed to document on confluence what is needed to ''just'' flat out publish an IG from the standpoint of the affiliates and alike. I assume the steps would be:
1) run the publisher with the proper arguments (whatever those arguments are - I've seen quite a couple of different arguments not currently documented - I guess I'll have to check out the code to get some information on that part)
2) on successful execution of the publisher with no errors , make a PR to the FHIR registry with the url where the IG is intended to be hosted
3) Provide hosting for the IG
4) go outside and have fun
Details on where and how the output of the publisher is hosted is left to the discretion of the person having executed the publisher
Jose Costa Teixeira (Feb 04 2021 at 14:23):
The trick is in the details. What I know now (may be wrong/outdated):
1.1. run the publisher with the right parameters after making sure that your files package-list.json and package.list...
1.2. setup a bunch of other stuff (history, registry)
1.3. run the publisher again (also with the right parameters and content), for an actual publication
-
make a PR to the registry if that is what you want
3.1 (hosting is easy) -
sure, go outside and have fun..... as soon as all the issues are fixed
Oliver Egger (Feb 04 2021 at 14:37):
instead of publishing to the registry we created an rss feed http://fhir.ch/package-feed.xml and registered that one so that we do not have to do a PR on every change of one of our ig's.
Jose Costa Teixeira (Feb 04 2021 at 15:28):
I think (at least for me) the key part is the actual publication step. @Jens Villadsen there's a bit of preparation there and some payload - this is whyI value the proposed change by Grahame.
Jose Costa Teixeira (Feb 04 2021 at 15:29):
Once that is up, I'd be glad to help document and automate parts of this.
Jens Villadsen (Feb 04 2021 at 16:07):
@Jose Costa Teixeira to me its still a black hole I'm looking into. History pages for previous publications is something we currently handle outside the IG. I can't say whether that saves us an execution of the publisher, but it sounds like that is the case.
Jose Costa Teixeira (Feb 04 2021 at 16:45):
Grahame started by saying this will be simplified, so I'm OK to not to hurt my brain over this until that change happens. It's a black hole for me as well (and I did reach the end of the tunnel before), but Grahame will provide us with something new, so I'm focusing on that.
Jose Costa Teixeira (Feb 04 2021 at 16:45):
We can always exchange idea about how it used to work / how it should work
Grahame Grieve (Feb 04 2021 at 19:32):
I will try and document how this works for HL7 next week
Grahame Grieve (Feb 04 2021 at 19:32):
(and how this will work)
Jens Villadsen (Feb 04 2021 at 22:08):
Thx a bunch
Last updated: Apr 12 2022 at 19:14 UTC
