Stream: committers
Topic: Fix bug in IG generation
Grahame Grieve (Mar 16 2019 at 22:16):
I've just fixed a significant bug in the IG generator. Here's the bug:
- as part of the publication process, the IG pubisher generates snapshots for any profiles that don't have snapshots
- It carefully checks the outcomes of the generation process and puts any exceptions/errors in the qa.html file
- but snapshots are generated earlier in the process under a variety of conditions
- if that process fails there, errors are not trapped - and the partially generated snapshot remains in place
- so when the IG publisher goes to check the snapshot, it already exists - and errors are not reported
Grahame Grieve (Mar 16 2019 at 22:18):
The first and most obvious fix is that partially generated snapshots should not be left in place - which I've fixed.
Grahame Grieve (Mar 16 2019 at 22:20):
a deeper question is whether the IG publisher should accept snapshots at all.
Grahame Grieve (Mar 16 2019 at 22:22):
but irrespective of that, as of the next release, the IG publisher will be making more checks on the profiles, and you may get more qa issues, or your build might fail. Once it's released, I'll do rebuild the current set of IGs on the ci-build to see if there's any problems
Rick Geimer (Mar 17 2019 at 08:00):
Maybe we add a command line option for the IG publisher about whether or not to accept snapshots, since I could definitely see that as a performance enhancement for local builds, but I don't think the CI build should use that option.
Eric Haas (Mar 17 2019 at 17:49):
I don't see many advantages to using snapshots for defining profiles. It may be useful for logical models and narrative or other text generation. I only use the differential when IG authoring and let the tooling deal with the snaphot generation.
AbdulMalik Shakir (Mar 18 2019 at 08:55):
@Grahame Grieve The IGs for VRDR and BSeR no longer build. I've made no changes to resources or profiles. All that I've done is remove some broken links and made minor modification to text. Also, the links http://build.fhir.org/ig/HL7/bser/index.html and http://build.fhir.org/ig/HL7/vrdr/index.html no longer point to the prior successful build. I think that this fix to the IG generation may have been a breaking change for my IGs. Is the fix absolutely necessary?
Grahame Grieve (Mar 18 2019 at 12:10):
yes it is necessary and you need to fix your IGs
Grahame Grieve (Mar 18 2019 at 12:10):
Unable to generate snapshot for http://hl7.org/fhir/us/bser/StructureDefinition/PatientAllergy because StructureDefinition PatientAllergy at AllergyIntolerance.verificationStatus: illegal constrained type code from CodeableConcept
Grahame Grieve (Mar 18 2019 at 12:10):
this you must fix
Grahame Grieve (Mar 18 2019 at 12:12):
Unable to generate snapshot for http://hl7.org/fhir/us/vrdr/StructureDefinition/VRDR-Funeral-Home-Director because StructureDefinition VRDR-Funeral-Home-Director.meta at PractitionerRole.meta.profile: illegal constrained type Reference from uri
this one too
AbdulMalik Shakir (Mar 18 2019 at 13:31):
@Grahame Grieve Any idea how many others might be affected and not know it?
Grahame Grieve (Mar 18 2019 at 19:01):
no.
Lloyd McKenzie (Mar 18 2019 at 19:13):
I've posted to the committers/announce stream. That should let everyone know.
Lloyd McKenzie (Mar 18 2019 at 19:13):
Anyone impacted has profiles that are already broken - they just might not have known prior to the fix
Last updated: Apr 12 2022 at 19:14 UTC
