Skip to content

hl7ch/ig-release

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

85 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Publish an implementation guide ch-xyz with a version

Background info see Process for Publishing a FHIR Implementation Guide (for non-HL7 IGs).

  1. Use github pages as a backup for the published IG's hl7ch.github.ch, we use this as a subfolder in ig-release
  2. Publish the guide from the local system to the github pages folder
  3. Sync github pages folder to google drive (which fhir.ch servs up the pages from including redirects)
  4. Update github pages

Repo ch-xyz (implementation guide)

Navigate to the IG repo:

cd ch-xyz
  1. Update/check the IG file ch.fhir.ig.[ch-xyz].xml or sushi-config.yaml.
  • date: 2023-12-19
  • version: 4.0.0 (or 4.0.0-ballot)
    • after the publication change the value to {next-proposed-version}-ci-build
  • releaselabel: trial-use (ci-build | draft | qa-preview | ballot | trial-use | release | update | normative+trial-use)
    • after the publication change the value to ci-build
  • dependencies -> verify the version values, incl. the correct terminology dependency (hl7.terminology: 5.4.0)
  • license: CC0-1.0
  1. Update the STU note box in index.md according to the type of publication (e.g. ballot):
This implementation guide is under STU ballot by [HL7 Switzerland](https://www.hl7.ch/) until September 30th, 2023 midnight.
Please add your feedback via the ‘Propose a change’-link in the footer on the page where you have comments. 
  1. Create/update the file publication-request.json in the IG root folder, see https://confluence.hl7.org/display/FHIR/IG+Publication+Request+Documentation.
    • after the publication rename the file to publication-request.json.bak
{
  "package-id" : "ch.fhir.ig.ch-core",
  "version" : "4.0.0",
  "path" : "http://fhir.ch/ig/ch-core/4.0.0",
  "mode" : "milestone",
  "status" : "trial-use",
  "sequence" : "STU 4",
  "desc" : "HL7 Switzerland STU 4",
  "changes" : "changelog.html",
  "first": false
}
  1. Build your IG local (for some checks).

  2. Verify also that the current version of the implementation guide is working in the CI build:
    http://build.fhir.org/ig/\[githubrepo\]/\[ch-xyz\]/index.html.

  3. Set a tag

git tag -a v4.0.0 -m "published version 4.0.0 on 2023-12-19"   
git push origin v4.0.0

and create a release in GitHub.

Repo ig-release

Navigate to the ig-release repo:

cd ..
cd ig-release
  1. Sync up github pages
cd hl7ch.github.io
git pull

if for the first time:

git clone https://github.com/hl7ch/hl7ch.github.io.git
  1. Download the latest version of the IG Publisher on a fresh clone with the publisher flag (in the ig-release folder). (Delete first the last one from an earlier publication if you have one.):
cd ..
wget https://github.com/HL7/fhir-ig-publisher/releases/latest/download/publisher.jar -o publisher.jar
  1. Run the IG Publisher assuming that your IG is on the same directory level as this project (this step uses the output folder from the IG ch-xyz, make sure that is up to date):
./publish.sh [ch-xyz]

Check the local output (incl. automatically filled out publication box) in hl7ch.github.io/ig/ch-xyz/4.0.0

  1. Verify that package-list.json is updated:
    ig-release/hl7ch.github.io/ig/[ch-xyz]/package-list.json

If not, please do following updates:

It didn't work automatically for following IG's during the last publication on 2023-12-20:

  • ch-allergyintolerance
  • ch-vacd
  1. For every IG publication:
./fhir-ch-www.sh ch-xyz 4.0.0
  1. Check the outputs, it might take a while due to caching issues:
  1. Update github packages
cd hl7ch.github.io 
git add .
git commit -m 'ch-xyz version'
git push   

and update ig-release

cd ..
git add .
git commit -m 'update after publication ch-xyz version'
git push   
  1. Check if the new entry is added in the package feed:
    https://fhir.ch/package-feed.xml

  2. Don't forget to set the mentioned things in the repo ch-xyz back to the ci-build.

Repo k8s-fhir.ch

  1. Update fhir.ch (if it is the first publication)
  • If the published IG is not yet linked on fhir.ch, add the requested links in the file k8s-fhir.ch\fhir-ch\index.html.

How to move tags ...

Delete the tag on any remote before you push

git push origin :refs/tags/
Replace the tag to reference the most recent commit

git tag -fa
Push the tag to the remote origin

git push origin --tags

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 77.5%
  • HTML 12.6%
  • CSS 9.7%
  • Other 0.2%