{"id":23360007,"url":"https://github.com/fhir/auto-ig-builder","last_synced_at":"2025-09-12T04:35:30.099Z","repository":{"id":42619604,"uuid":"64245771","full_name":"FHIR/auto-ig-builder","owner":"FHIR","description":"Implementation Guide builder","archived":false,"fork":false,"pushed_at":"2025-03-11T18:04:40.000Z","size":501,"stargazers_count":51,"open_issues_count":5,"forks_count":20,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-04-06T09:10:00.954Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FHIR.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-07-26T18:42:55.000Z","updated_at":"2025-03-11T18:04:44.000Z","dependencies_parsed_at":"2024-05-16T17:31:47.921Z","dependency_job_id":"d7cebd71-0b6c-462f-ac95-9fb945aee62a","html_url":"https://github.com/FHIR/auto-ig-builder","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FHIR%2Fauto-ig-builder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FHIR%2Fauto-ig-builder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FHIR%2Fauto-ig-builder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FHIR%2Fauto-ig-builder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FHIR","download_url":"https://codeload.github.com/FHIR/auto-ig-builder/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248703195,"owners_count":21148116,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-21T11:12:49.365Z","updated_at":"2025-04-13T10:55:33.491Z","avatar_url":"https://github.com/FHIR.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FHIR Implementation Guide Auto-Builder\n\n## About Auto-Builder\n\nUse this tool if you're working on an FHIR Implementation Guide in a **public GitHub repository** and want your work-in-progress to be visible as part of the FHIR Continuous Integration (CI) build service at https://build.fhir.org/ig/.\n\nBy following the instructions below, you can configure your GitHub repository to auto-build every time you make a commit (on any branch), and the resulting output (successful IG content, or debugging logs) will automatically be pushed to https://build.fhir.org/ig/.\n\n## Quick start guide\n\n0. **Create an IG** in a new folder, including a file called `ig.ini` alongside any other content (for example a `pages` folder) that your IG requires. See https://confluence.hl7.org/display/FHIR/IG+Publisher+Documentation for full documentation.\n1. **Put your IG on GitHub**: create a public GitHub repository within your own organization, and push your content to GitHub.\n2. **Add FHIR IG Builder**: Install https://github.com/apps/fhir-ig-builder on your org or repo. \n\n**Now GitHub will automatically trigger a build whenever you commit changes. :-)**\n\n### Important Notes\n* branches are `[A-Za-z0-9_-]` only. Other characters such as **`/` will not work in branch names**\n* build notifications at https://chat.fhir.org/#narrow/stream/179297-committers.2Fnotification/topic/ig-build\n* builds takes 2-3 minutes to complete\n\n\u003cdetails\u003e\n  \u003csummary\u003eClick to show alternative method (manually configured webhook)\u003c/summary\u003e\nIn your repo, click \"Settings\", then \"Webhooks \u0026 Services\", then \"Add Webhook\"\nEnter a URL of `https://us-central1-fhir-org-starter-project.cloudfunctions.net/ig-commit-trigger`\nChoose \"Content type\" of `application/json`\nAccept the default (blank) \"secret\".\nChoose \"Just the push event\" as your trigger\nClick \"Add webhook\".\nNote: first webhook call will of type `ping` and will fail. That is (currently) OK. Once you make a commit and a push, a call of type `push` will be made and that should be successful if your setup is correct.\n\n\u003c/details\u003e\n\n\n\n## After the build is complete, you can...\n\n### Find your rendered IG automatically available at\n\nhttps://build.fhir.org/ig/:org/:repo/branches/:branch\n\n(The default branch will also be available directly at https://build.fhir.org/ig/:org/:repo .)\n\n### Find debugging info about the build\n\nFor a build log, see:\nhttps://build.fhir.org/ig/:org/:repo/branches/:branch/build.log\n\n(Logs for the default branch will also be available directly at https://build.fhir.org/ig/:org/:repo/build.log .)\n\nIn case the build failed, the log will be available in https://build.fhir.org/ig/:org/:repo/branches/:branch/failure/build.log\n\n#### If you want to manually trigger a build\n\nYou can always push a new commit to your repo. But if you want to re-trigger a build for an existing commit, you have a couple of options.\n\nYou can use the dashboard at https://fhir.github.io/auto-ig-builder.\n\nOr if you're using web hooks, you can navigate through the GitHub UI within your repo to \"Settings \u003e Webhooks \u003e ig-commit-trigger\", scroll down to \"Recent Deliveries,\" click the top one, and click \"Redeliver.\n\nOr if you want to trigger a build programatically, you can `POST` to the Webhook URL yourself, specifying a branch, org, and repo. For example with the `test-igs` org, `simple` repo, and `master` branch:\n\n```\ncurl -X POST  \"https://us-central1-fhir-org-starter-project.cloudfunctions.net/ig-commit-trigger\" \\\n  -H \"Content-type: application/json\" \\\n  --data '{\"ref\": \"refs/heads/master\", \"repository\": {\"full_name\": \"test-igs/simple\"}}'\n```\n\n### Summary/stats of current ci builds\nLatest summary/stats of the ci ig builds are available at [https://fhir.github.io/auto-ig-builder](https://fhir.github.io/auto-ig-builder/builds.html)\n\n# IG Auto-Builder Purge Policy\n\n## Automated Cleanup\n\n* Branches older than 90 days with no activity are automatically removed\n* Only main branches (`main` or `master`) of official HL7, FHIR, IHE, and Argonaut repositories are exempt from purging\n\n## Keeping Your Branch\n\n* Make a commit to your branch at least once every 90 days to prevent purging\n* For repositories not in the exempted organizations, even main branches will be purged if inactive\n\n## After Purging\n\n* Purged content cannot be restored from the build service\n* Your GitHub source code remains unaffected\n* You can rebuild by pushing to the same branch again\n---\n\n## Developer Overview\n\n* [Dev Setup](./k8s/dev-setup.md)\n* [Architecture Overview Slide](https://docs.google.com/presentation/d/12JykZwSdQ1pwSuzP2fGZSXr3jYMmvEcwVgNAy3dWr_U/present)\n* [Accompanying Video](https://youtu.be/VVbF1O4pgQA)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffhir%2Fauto-ig-builder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffhir%2Fauto-ig-builder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffhir%2Fauto-ig-builder/lists"}