The GitHub integration enables you to link Simplier projects to GitHub repositories. When linking the project with the repository, the resources from the repository are fetched and added to your Simplifier project. The GitHub integration is part of the paid account plans of Simplifier. This page will elaborate further on how to perform the linking.
When connecting a GitHub repository you will be asked to choose a strategy about how to deal with resources that fail to import (most likely because they are not valid FHIR resources) and whether to remove resources from your project when they are removed from your repository.
After the linking is performed, any updates to your resources in the GitHub repository will be sent automatically to Simplifier. Based on the the linking settings, resources from your Simplifier project will be updated to, deleted from, or added to GitHub.
GitHub Sync enables you to synchronize your Simplifier project with the linked GitHub repository. Images or css files that up until recently were not supported by Simplifier are now available. If you decided to skip the initial import after linking or you have old markdown, you are now able to access them in Simplifier by using the sync process.
The include/exclude feature allows users to specify the folders or file types that should be fetched from GitHub into Simplifier. This also applies to the folders or file types that you would like to be excluded from the import. You are able to specify these rules right after the initial link to the repository, before the initial import or later by accessing the
Settings option from the
Github dropdown menu on the project page.
By default, everything is included. If include statements are added then everything else (not included in your include statement) will be excluded by default. Simplifier only imports xml, json, images, and markdown file types. Comments are also supported using the “#” character.
The syntax is the following:
Gitwebhook per Branch¶
For our Team and Enterprise account users, we added the ability to filter files that are synced from GitHub. We followed the .gitignore logic, but expanded it slightly to work from a include perspective as well. After you’ve set up a GitHub link, you can specify rules to include or exclude certain files or folders from your GitHub repository.
- # Include all files under examples folder:
- # Include all files and folders under staging:
- # Include all xml files:
- # Exclude all json files under temp folder:
Note that if you only use exclude patterns (starting with a exclamation mark !), Simplifier will assume you want to include everything but those filters.
You can use the same globbing patterns you are used to in a .gitignore file.
GitHub webhook to manage Implementation Guides¶
The GitHub webhook allows you to edit your Implementation Guide without using the editor itself. Your GitHub repository can contain an IG resource which states the structure of the IG and refers to all the included pages (also in the same repository).
To get started, you create a project and establish a webhook to your GitHub repository.
- Create an ImplementationGuide resource, or download an ImplementationGuide resource from a Simplifier project together with all the belonging content (.md pages, images, etc.)
- Push the resources to your GitHub repository.
- Your Simplifier project will now contain all these files. Locate the ImplementationGuide resource.
- Click on
Edit: Update by editing in IG editor. This will convert the ImplementationGuide resource to a Simplifier IG.
- Choose the desired conversion settings of your IG.
- The Implementation Guide editor will now open with your IG - leave it as-is. You will also find the IG in the Guides tab of your project.
From now on, you can edit the ImplementationGuide resource and its pages from within your GitHub repository. Your changes will be automatically pushed to Simplifier and your online Implementation Guide.