Merge pull request #199 from palewire/dependabot/pip/django-4.2.15 #149
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 documentation" | |
on: | |
push: | |
workflow_dispatch: | |
jobs: | |
build: | |
name: Build | |
runs-on: ubuntu-latest | |
steps: | |
- id: checkout | |
name: Checkout | |
uses: actions/checkout@v4 | |
- id: setup-python | |
name: Setup Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.11' | |
cache: 'pipenv' | |
- id: install-pipenv | |
name: Install pipenv | |
run: curl https://raw.githubusercontent.com/pypa/pipenv/master/get-pipenv.py | python | |
shell: bash | |
- id: install-python-dependencies | |
name: Install Python dependencies | |
run: pipenv sync --dev | |
shell: bash | |
- id: build-sphinx-documentation | |
name: Build Sphinx documentation | |
run: pipenv run make html | |
shell: bash | |
working-directory: docs | |
- id: upload-release-candidate | |
name: Upload release candidate | |
uses: actions/upload-artifact@v3 | |
with: | |
name: release-candidate | |
path: ./docs/_build/html/ | |
deploy: | |
name: Deploy | |
runs-on: ubuntu-latest | |
needs: build | |
if: ${{ github.ref_name == 'main' }} | |
steps: | |
- name: Download release candidate | |
uses: actions/[email protected] | |
with: | |
name: release-candidate | |
path: ./docs/ | |
- id: configure-aws | |
name: Configure AWS Credentials | |
uses: aws-actions/configure-aws-credentials@v4 | |
with: | |
aws-access-key-id: ${{ secrets.PALEWIRE_DOCS_AWS_ACCESS_KEY_ID }} | |
aws-secret-access-key: ${{ secrets.PALEWIRE_DOCS_AWS_SECRET_ACCESS_KEY }} | |
aws-region: us-east-1 | |
- id: upload-to-s3 | |
name: Upload documentation to Amazon S3 | |
uses: datadesk/delivery-deploy-action@v1 | |
with: | |
bucket: ${{ secrets.PALEWIRE_DOCS_AWS_BUCKET }} | |
base-path: django-postgres-copy/ | |
dir: ./docs/ | |
should-cache: false | |
use-accelerate-endpoint: false | |
public: true |