search

HL7 / fhir-ig-publisher

Source code for the IG publisher
Apache License 2.0
71 stars 57 forks source link

Automated generation of changes #374

Closed seanmcilvenna closed 1 month ago

seanmcilvenna commented 2 years ago

When publishing a new version of an IG, would be great to have the IG Publisher do a diff of old profiles to new profiles, and generate a concise change list.

lmckenzi commented 2 years ago

I think it already does this? However, we might not be properly surfacing the results. It would also be helpful if we could indicate for profiles whose URLs have changed what the equivalent(s) were in the prior version to support that mapping (and maybe even explicitly declare "this replaces x and y in version 123").

grahamegrieve commented 2 years ago

It’s only Available from the qa page

Sent from my iPhone

On 19 Jan 2022, at 10:16 am, Lloyd McKenzie @.***> wrote:

 I think it already does this? However, we might not be properly surfacing the results. It would also be helpful if we could indicate for profiles whose URLs have changed what the equivalent(s) were in the prior version to support that mapping (and maybe even explicitly declare "this replaces x and y in version 123").

— Reply to this email directly, view it on GitHub, or unsubscribe. Triage notifications on the go with GitHub Mobile for iOS or Android. You are receiving this because you are subscribed to this thread.

seanmcilvenna commented 2 years ago

The request comes from SDWG (and ITS) requiring that new versions of an IG have a change history so that implementers can see

  1. Which profiles have changed
  2. Which parts of the profiles have changed (i.e. which elements, new/changed narrative text, etc.)

Great that the IG Publisher produces something like this already, but would be great to have this in the published IG, not just the QA.

lmckenzi commented 1 month ago

We're now generating pages that look like this: https://build.fhir.org/ig/HL7/fhir-extensions/comparison-v1.0.0/index.html that you could link to from elsewhere in your IG if you wish. There's also the change flag you can set on generation that gives you content that looks like this: https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-obligation.html

No further action to be taken. If you think more is necessary, please submit a new tracker describing in detail what else is needed.