Stream: IG creation
Topic: what do I do about this warning?
Eric Haas (Jul 24 2020 at 17:32):
What do I do about this warning?
I am unclear what jira specification file this is talking about. Are there instructions somewhere?
The jira specification file appears to be out of date with the versions, artifacts and pages currently defined in the IG. A proposed revised file to be reviewed and, if appropriate, submitted as a pull request against the XML folder in https://github.com/HL7/JIRA-Spec-Artifacts.
Jean Duteau (Jul 24 2020 at 17:40):
It means that your IGuide isn't in the list if artifacts for JIRA. Here is what Lloyd told me to do:
Ignore that until you think things are 'stable', but yes, in the end you/I will need to do a pull request against Jira-Spec-Artifacts
Lloyd McKenzie (Jul 24 2020 at 17:44):
The instructions are here: https://confluence.hl7.org/display/HL7/Configuring+Specification+Feedback
Lloyd McKenzie (Jul 24 2020 at 17:44):
You need to take care of this before going to ballot or final publication. (It ensures that the drop-downs in Jira reflect what's actually in your IG.)
Carl Anderson (Jul 24 2020 at 18:02):
I recently went through this, Eric, with the SMART Web Messaging spec. I'd be happy to help you get straightened out since it's still fresh in my mind.
Eric Haas (Jul 30 2020 at 23:43):
I updated the file for DEQM but the warning persists? @Lloyd McKenzie
Rob Hausam (Jul 30 2020 at 23:58):
This process seems to be quite fragile. In IPS and so far in Order Catalog the pull request against Jira-Spec-Artifacts hasn't resolved the warning - as apparently is also the case now for Eric.
Lloyd McKenzie (Jul 31 2020 at 01:20):
It's super whitespace sensitive. If the file has a single carriage return of difference, it'll yell. It's on my list to make it smarter by normalizing both files before comparison, but I don't expect that to happen for a while. If someone wants to take on the task sooner, that'd be awesome.
Lloyd McKenzie (Jul 31 2020 at 01:21):
If you've done a file compare and there are no significant differences, add it to the ignore list and include the date of your verification in the comment
Grahame Grieve (Jul 31 2020 at 01:21):
how does it do the comparison?
Lloyd McKenzie (Jul 31 2020 at 01:22):
Ant file compare
Eric Haas (Jul 31 2020 at 02:41):
should we minimize?
Lloyd McKenzie (Jul 31 2020 at 13:19):
Don't understand what you mean by 'minimize'. If you mean 'strip all whitespace before comparison, that's sort of what I meant by normalize - though I'd probably change to 'standard' whitespace so that if anyone wanted to do a diff on the comparison files, the diff would render 'nicely'.
Rob Hausam (Jul 31 2020 at 14:55):
I think we do need to get this fixed - soon. People seem to be spending quite a bit of time on it, only due to differences in whitespace (which aren't obvious and apparently aren't documented).
Rob Hausam (Jul 31 2020 at 14:59):
Can we make it so the IG Publisher generates the file using the "correct" whitespace?
Lloyd McKenzie (Jul 31 2020 at 15:14):
The IG Publisher generates the file consistently. If what gets pushed to Github is identical, there should be no issues (though it's possible there's a weird Github or XSLT line ending conversion thing happening based on what platform people are using).
François Macary (Jul 31 2020 at 15:45):
I aligned the white spaces on SPECS-FHIR and FHIR-order-catalog, which did not succeed to make the warning go away. So I'm now suppressing it as suggested by @Lloyd McKenzie above.
Lloyd McKenzie (Jul 31 2020 at 15:53):
Out of curiosity, do you use Windows or Mac?
François Macary (Jul 31 2020 at 16:29):
Windows
Lloyd McKenzie (Jul 31 2020 at 16:37):
Then I don't know what's happening :(
François Macary (Jul 31 2020 at 16:53):
The differences I noticed are about the number of leading spaces on each line.
Eric Haas (Jul 31 2020 at 17:58):
(deleted)
Eric Haas (Jul 31 2020 at 18:39):
the suppressed Message file does not work for me.
== Suppressed Messages ==
# successful PR to https://github.com/hl7/jIRA-Spec-Artifacts on Jul 27, 2020 https://github.com/HL7/JIRA-Spec-Artifacts/commits/master/xml/FHIR-us-davinci-deqm.xml
The jira specification file appears to be out of date with the versions, artifacts and pages currently defined in the IG. A proposed revised file to be reviewed and, if appropriate, submitted as a pull request against the XML folder in https://github.com/HL7/JIRA-Spec-Artifacts.
Eric Haas (Jul 31 2020 at 18:40):
still shows up as a warning.
Lloyd McKenzie (Jul 31 2020 at 20:23):
Did you copy it 'as is' from qa.txt?
Eric Haas (Jul 31 2020 at 20:25):
from qa.html
Lloyd McKenzie (Jul 31 2020 at 20:27):
Try copying from qa.txt
Lloyd McKenzie (Jul 31 2020 at 20:27):
The HTML sometimes prettifies things
Rob Hausam (Aug 01 2020 at 02:15):
Using qa.txt worked to suppress the warning for Order Catalog (Francois verified that today).
Eric Haas (Aug 01 2020 at 20:32):
I will add that important detail to the intstructions.
What is the policy on hiding errors? Because I never did before
Lloyd McKenzie (Aug 01 2020 at 20:40):
Errors generally can't be suppressed - only exception is broken links
Last updated: Apr 12 2022 at 19:14 UTC