change important admonition to note #907
Workflow file for this run
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 docs" | |
on: | |
push: | |
workflow_dispatch: | |
release: | |
types: [published] | |
jobs: | |
build: | |
runs-on: ubuntu-22.04 | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- uses: actions/setup-python@v4 | |
with: | |
python-version: "3.10" | |
- name: apt-get update | |
run: sudo apt-get update | |
- name: Install external dependencies | |
run: sudo apt-get install build-essential libpoppler-cpp-dev pkg-config python3-dev -y | |
- name: Install sec-certs and deps | |
run: | | |
pip install -r requirements/dev_requirements.txt | |
pip install -e . | |
- name: Build docs | |
run: | | |
cd docs | |
make html | |
- name: Save docs artifact | |
uses: actions/upload-artifact@v3 | |
with: | |
name: docs | |
path: docs/_build/html/ | |
retention-days: 7 | |
upload: | |
runs-on: ubuntu-latest | |
needs: build | |
if: (startsWith(github.ref, 'refs/tags/') || github.ref == 'refs/heads/main') && github.repository == 'crocs-muni/sec-certs' # Potentially change this into a check on release. | |
steps: | |
- name: Get docs artifact | |
uses: actions/download-artifact@v3 | |
with: | |
name: docs | |
path: docs | |
- name: Archive docs | |
run: | | |
cd docs | |
zip -r docs.zip * | |
- name: Push docs to website | |
run: | | |
curl -F data=@docs/docs.zip https://sec-certs.org/docs/upload?token=${{ secrets.DOCS_AUTH_TOKEN }} |