HL7 / ImmunizationFHIRDS

A FHIR implementation guide to support Immunization Decision Support
0 stars 4 forks source link

Incompatible Project Structure for SUSHI 2.0 #17

Open cmoesel opened 3 years ago

cmoesel commented 3 years ago

Problem: This project uses a project structure that will no longer be supported by SUSHI, as of SUSHI 2.0.0. If your project uses the HL7 IG Autobuild, auto builds will fail after SUSHI 2.0.0 comes out of beta.

Preferred Solution: The preferred way to fix this problem is to update your project to use the supported project structure and configuration (e.g., standard IG template project structure with an input/fsh folder). We suggest following the Migrating from Older Versions instructions on FSH School.

Alternate Solution: If it is not feasible to make these changes in a timely manner, you can "lock in" the version of SUSHI that the IG Publisher uses by creating or updating a fsh.ini file at the root of your project. For example, the following fsh.ini file would tell the IG Publisher to always use SUSHI 1.3.2, even after SUSHI 2.0.0 is released:

[FSH]
sushi-version=1.3.2

Timeline: In order to avoid being affected by the official SUSHI 2.0.0 release, we recommend you implement one of the above solutions by July 6, 2021.

More Information / Questions: For more information about SUSHI 2.0, you can read the SUSHI 2.0.0 Beta 1 Release Notes. For more information about updating your project to the supported project structure, see Migrating from Older Versions on FSH School. If you have questions, you can reach out to the SUSHI team via the #shorthand stream on Zulip or by logging an issue on SUSHI.

sorech02 commented 3 years ago

@cmoesel I think this merge addressed the issue. Can you confirm?

cmoesel commented 3 years ago

@sorech02 -- You're very close! It works well w/ SUSHI, but if you run the IG Publisher on it, you'll see that there are a couple of issues -- the main one being that the ig.ini file is pointing to the ImplementationGuide in the wrong location. Here are the changes I think you need to make:

  1. Update ig.ini to remove the old SUSHI warning text and point to the ImplementationGuide resource in its new location:

    [IG]
    ig = fsh-generated/resources/ImplementationGuide-hl7.fhir.us.immds.json 
    template = hl7.fhir.template#0.1.0
    
  2. Add an input/ignoreWarnings.txt file with the following contents:

    == Suppressed Messages ==
    
    # Format: https://confluence.hl7.org/pages/viewpage.action?pageId=66938614#ImplementationGuideParameters-ManagingWarningsandHints
  3. Add /input-cache/publisher.jar to your .gitignore file
  4. Replace your .bat scripts with the latest ones from here: https://github.com/HL7/ig-publisher-scripts
sorech02 commented 3 years ago

@cmoesel another merge to look at when you have a chance.