From 294b478f317ed7ea5d2dce2eeab8ecd15ce95b5d Mon Sep 17 00:00:00 2001 From: jfaldanam Date: Tue, 18 Jun 2024 15:43:14 +0200 Subject: [PATCH] feat: First version of documentation pipeline --- .github/workflows/docs.yml | 51 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..2ac1500 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,51 @@ +name: Generate and deploy OpenAPI Docs + +on: + push: + branches: + - master + - feat/generate-docs + +jobs: + generate-docs: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v5 + with: + python-version: + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install ".[dev]" + + - name: Generate OpenAPI JSON + run: python scripts/generate_openapi.py + + - name: Set up Node.js + uses: actions/setup-node@v3 + with: + node-version: '14' + + - name: Install Redoc CLI + run: npm install -g redoc-cli + + - name: Generate HTML from OpenAPI JSON + run: npx @redocly/cli build-docs openapi.json + + - name: Move generated HTML to docs directory + run: mv redoc-static.html docs/index.html + + - name: Upload artifact + uses: actions/upload-pages-artifact@v1 + with: + path: ./docs + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v1