-
Notifications
You must be signed in to change notification settings - Fork 49
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
538 additions
and
462 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"name": "Python 3", | ||
"image": "mcr.microsoft.com/devcontainers/python:1-3.11-bookworm", | ||
"features": { | ||
"ghcr.io/devcontainers-contrib/features/pipenv:2": {} | ||
}, | ||
"postCreateCommand": "pipenv sync --dev" | ||
} |
This file was deleted.
Oops, something went wrong.
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,75 @@ | ||
name: "Build documentation" | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
workflow_dispatch: | ||
|
||
jobs: | ||
docs: | ||
name: "Build and deploy" | ||
build: | ||
name: Build | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
|
||
- uses: ammaraskar/sphinx-action@master | ||
with: | ||
docs-folder: "docs/" | ||
|
||
- uses: actions/upload-artifact@v3 | ||
with: | ||
name: documentation-html | ||
path: docs/_build/html/ | ||
|
||
- uses: shallwefootball/s3-upload-action@master | ||
with: | ||
aws_key_id: ${{ secrets.PALEWIRE_DOCS_AWS_ACCESS_KEY_ID }} | ||
aws_secret_access_key: ${{ secrets.PALEWIRE_DOCS_AWS_SECRET_ACCESS_KEY }} | ||
aws_bucket: ${{ secrets.PALEWIRE_DOCS_AWS_BUCKET }} | ||
source_dir: docs/_build/html/ | ||
destination_dir: django-postgres-copy | ||
- 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/download-artifact@v3 | ||
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 |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,4 +19,4 @@ wheel = "*" | |
pre-commit = "*" | ||
|
||
[requires] | ||
python_version = "3.10" | ||
python_version = "3.11" |
Oops, something went wrong.