Add the cookiecutter template for sphinx #1
This file contains 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 Sphinx Docs | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| pull-requests: write | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.8' | |
| - name: Install Poetry | |
| run: curl -sSL https://install.python-poetry.org/ | python - | |
| - name: Add Poetry to PATH | |
| run: echo "$HOME/.poetry/bin" >> $GITHUB_PATH | |
| - name: Install dependencies | |
| run: poetry install | |
| - name: Build HTML docs | |
| run: poetry run make docs-ci | |
| - name: Upload HTML docs | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: m3tid-docs-html | |
| path: docs/_build/dirhtml/ | |
| # Delete this job before public release and clear GitHub secrets: | |
| azure_blob: | |
| needs: docs | |
| runs-on: ubuntu-latest | |
| env: | |
| AZURE_STORAGE_ACCOUNT: m3tid | |
| AZURE_STORAGE_SAS_TOKEN: ${{ secrets.AZURE_SAS_TOKEN }} | |
| BRANCH_NAME: ${{ github.head_ref || github.ref_name }} | |
| STATICRYPT_PASS: ${{ secrets.STATICRYPT_PASS }} | |
| steps: | |
| - uses: actions/setup-node@v3 | |
| with: | |
| node-version: '19' | |
| - run: npm install -g staticrypt | |
| - name: Download HTML docs | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: m3tid-docs-html | |
| path: docs | |
| - run: > | |
| staticrypt --remember 3 --salt cRryVbKHFDvNHCopcmhnkQzqXnthejYC \ | |
| --password $STATICRYPT_PASS --short \ | |
| --template-title "M3TID (branch: $BRANCH_NAME)" \ | |
| --template-instructions "The contents of this site are marked TLP:AMBER:CTID-R&D:23-84. Do not share with unauthorized individuals." \ | |
| --template-color-primary "#6241c5" \ | |
| --template-color-secondary "#b2b2b2" \ | |
| --template-button "Log In" \ | |
| -r docs/ | |
| - name: Ensure StatiCrypt ran # StatiCrypt will fail without warning; verify it created a directory | |
| run: test -d encrypted | |
| - name: Copy encrypted HTML files | |
| run: rsync -Ir -v --include='*.html' --exclude='*.*' encrypted/docs . | |
| - name: Set the branch name | |
| run: mv docs "$BRANCH_NAME" | |
| - name: Install Azure CLI | |
| run: curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash | |
| - name: Delete old blobs | |
| run: az storage blob delete-batch -s '$web' --pattern "$BRANCH_NAME/*" | |
| - name: Upload to blob storage | |
| run: az storage blob upload-batch -s . --pattern "$BRANCH_NAME/*" -d '$web' | |
| - uses: actions/github-script@v6 | |
| if: github.event_name == 'pull_request' | |
| with: | |
| script: | | |
| github.rest.issues.createComment({ | |
| issue_number: context.issue.number, | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| body: `This PR has been published to https://${process.env['AZURE_STORAGE_ACCOUNT']}.z13.web.core.windows.net/${process.env['BRANCH_NAME']}/`, | |
| }) | |
| # # TODO Uncomment before publishing repository. | |
| # github_pages: | |
| # # This job only runs when committing or merging to main branch. | |
| # if: github.ref_name == 'main' | |
| # needs: docs | |
| # runs-on: ubuntu-latest | |
| # environment: | |
| # name: github-pages | |
| # url: $\{\{ steps.deployment.outputs.page_url \}\} | |
| # steps: | |
| # - name: Setup Pages | |
| # uses: actions/configure-pages@v2 | |
| # - name: Download HTML docs | |
| # uses: actions/download-artifact@v3 | |
| # with: | |
| # name: m3tid-docs-html | |
| # path: docs | |
| # - name: Upload artifact | |
| # uses: actions/upload-pages-artifact@v1 | |
| # with: | |
| # path: ./docs | |
| # - name: Deploy to GitHub Pages | |
| # id: deployment | |
| # uses: actions/deploy-pages@v1 |