search

HL7 / US-Core

FHIR R4 version of US Core IG
29 stars 28 forks source link

Incompatible Project Structure for SUSHI 2.0 #35

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.

cmoesel commented 3 years ago

The above message is the general message I prepped for all projects that used a non-standard project layout (but contained FSH files). This project seems to be a bit different than others since it contains an input/_fsh folder and a checked in fsh-generated folder, which seems to be intentionally avoiding SUSHI generation during build time. Still, SUSHI 2.0 operates differently than SUSHI 1.0 -- and this project will be (adversely) affected. Feel free to reach out to discuss the best way forward.