ci: Integrate GitHub Pages deployment into build workflow #75
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Build and Deploy Documentation | |
| on: | |
| push: | |
| branches: [main] | |
| paths: | |
| - 'software/documentation/**' | |
| - 'software/sphinx/**' | |
| - 'README.md' | |
| - '.github/workflows/build_pdf.yml' | |
| pull_request: | |
| branches: [main] | |
| paths: | |
| - 'software/documentation/**' | |
| - 'software/sphinx/**' | |
| - 'README.md' | |
| workflow_dispatch: | |
| permissions: | |
| contents: write | |
| pages: write | |
| id-token: write | |
| jobs: | |
| build-and-deploy: | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.10' | |
| - name: Install dependencies (Python + LaTeX + Ghostscript) | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y texlive-latex-extra texlive-fonts-recommended texlive-lang-english ghostscript latexmk | |
| pip install -r software/documentation/requirements.txt | |
| pip install -r software/sphinx/requirements.txt | |
| ################################################# | |
| # Generar PDF del Product Brief con nombre del repo | |
| ################################################# | |
| - name: Build LaTeX PDF from README | |
| working-directory: software/documentation | |
| env: | |
| REPO_NAME: ${{ github.event.repository.name }} | |
| run: | | |
| python test_readme.py | |
| python generate_pdf.py | |
| gs -sDEVICE=pdfwrite -dCompatibilityLevel=1.4 -dPDFSETTINGS=/printer \ | |
| -dNOPAUSE -dQUIET -dBATCH \ | |
| -sOutputFile=build/${REPO_NAME}_product_brief.pdf build/*.pdf | |
| ################################################# | |
| # Generar Documentación Sphinx (HTML + PDF) | |
| ################################################# | |
| - name: Build Sphinx Documentation | |
| working-directory: software/sphinx | |
| run: | | |
| make clean | |
| make pdfx | |
| ################################################# | |
| # Preparar contenido para docs/ | |
| ################################################# | |
| - name: Prepare docs/ directory | |
| env: | |
| REPO_NAME: ${{ github.event.repository.name }} | |
| run: | | |
| rm -rf docs | |
| mkdir -p docs | |
| # PDF generado desde LaTeX | |
| cp software/documentation/build/${REPO_NAME}_product_brief.pdf docs/ | |
| # PDF generado por Sphinx | |
| cp software/sphinx/pdf/programmer.pdf docs/${REPO_NAME}_sphinx.pdf | |
| # HTML generado por Sphinx | |
| cp -r software/sphinx/docs/* docs/ | |
| # Permitir archivos especiales en GitHub Pages | |
| touch docs/.nojekyll | |
| ################################################# | |
| # Deploy to GitHub Pages | |
| ################################################# | |
| - name: Setup Pages | |
| if: github.ref == 'refs/heads/main' | |
| uses: actions/configure-pages@v4 | |
| - name: Upload artifact | |
| if: github.ref == 'refs/heads/main' | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: 'docs' | |
| - name: Deploy to GitHub Pages | |
| if: github.ref == 'refs/heads/main' | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |