FHIR GIT

From IHE Wiki
Revision as of 15:31, 12 July 2018 by Smoore (talk | contribs) (First version of notes on using GIT for our FHIR artifacts)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Intro

This page contains notes/thoughts on how IHE might use GIT to manage the artifacts for our FHIR development. As I write this, I am sure there are things that are just plain wrong. Question everything that is written here. We will eventually need our committee to either bless, delete or tweak these ideas.

Expiration Date

This page expires 2018.12.31. It is intended as a place to gather notes and thoughts. It should go away once we have a clear direction.

Assumptions

  1. Readers are familiar with GIT as a mechanism for source code and other file control.
    1. Here is one source of material. Google will identify many more: https://git-scm.com/doc
  2. Readers might not be comfortable with using branches within GIT. That should not be an issue at first.
  3. Readers might not have used GIT themselves. There are a number of different tools to manage files under GIT, but our readers may not have had the need to use them.
    1. Fear not

Example Repository on GITHUB

I made a repository on GITHUB that is intended to be a sandbox: https://github.com/IHE/fhir

The structure of the repository matches the structure created on the IHE FTP server that John Moehrke created. I entered several versions of the MHD artifacts that John had placed in a separate folder. That means that one can look at this repository and find

  1. Current version of each file
  2. Prior version of each file
  3. Deltas between versions

This is all managed by GIT which does not care about XML, JSON, ... GIT just manages the files as a blob of bytes. It works best for text files (code, xml, json, etc.).

As a further example using this same repository, we can publish a link to a file such as: [ttps://github.com/IHE/fhir/blob/master/StructureDefinition/IHE.MHD.DocumentManifest.structuredefinition.xml ttps://github.com/IHE/fhir/blob/master/StructureDefinition/IHE.MHD.DocumentManifest.structuredefinition.xml]. As human could follow that link, find the file and look through the commit history.