From 64f2ea2a7fcf4a5e63f127f0d0bfdeabf8d3e9ef Mon Sep 17 00:00:00 2001 From: Matti Schneider Date: Tue, 21 May 2024 06:11:17 +0200 Subject: [PATCH] Enable doc to be built deployed from Core --- .github/workflows/deploy.yaml | 1 + README.md | 6 ++++++ 2 files changed, 7 insertions(+) diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml index 946f2046..25a38c27 100644 --- a/.github/workflows/deploy.yaml +++ b/.github/workflows/deploy.yaml @@ -1,6 +1,7 @@ name: Deploy on: + workflow_dispatch: # triggered by Core to rebuild the documentation when code comments change push: branches: [ master ] diff --git a/README.md b/README.md index 324a7128..91cb6ecc 100644 --- a/README.md +++ b/README.md @@ -101,3 +101,9 @@ That's it! 🙌 ## Using icons You can use icons by choosing one from [Lucide](https://lucide.dev) and adapting the code `` with the relevant icon name. + +## Deploy + +The documentation is built as a static website on GitHub Actions with Sphinx. The built files are committed and pushed to the `doc` folder of the GitHub Pages-published branch of the `openfisca.org` repository. + +OpenFisca-Core triggers a deployment on the Doc repository whenever a new Core version is deployed, to ensure that the Python and Web API auto-generated documentations are up to date. This is done with [`workflow_dispatch`](https://docs.github.com/en/rest/actions/workflows?apiVersion=2022-11-28#create-a-workflow-dispatch-event--fine-grained-access-tokens) using a personal access token of @openfisca-bot. This personal access token has a maximum lifetime of one year, and will thus need to be updated every year.