mirror of
https://github.com/aaronpo97/the-biergarten-app.git
synced 2026-10-14 17:54:42 +00:00
Refactor documentation and diagrams for web/pipeline. (#272)
Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com> for assistance with diagram creation and documentation prose updates.
This commit is contained in:
51
.github/workflows/deploy-docs.yml
vendored
Normal file
51
.github/workflows/deploy-docs.yml
vendored
Normal file
@@ -0,0 +1,51 @@
|
||||
name: Deploy Docs to GitHub Pages
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- docs
|
||||
paths:
|
||||
- "docs/**"
|
||||
- "mkdocs.yml"
|
||||
- ".github/workflows/deploy-docs.yml"
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
pages: write
|
||||
id-token: write
|
||||
|
||||
concurrency:
|
||||
group: pages
|
||||
cancel-in-progress: false
|
||||
|
||||
jobs:
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
environment:
|
||||
name: github-pages
|
||||
url: ${{ steps.deployment.outputs.page_url }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: "3.11"
|
||||
|
||||
- name: Install dependencies
|
||||
run: pip install mkdocs mkdocs-material mkdocs-glightbox mkdocs-panzoom-plugin mkdocs-minify-plugin
|
||||
|
||||
- name: Build site
|
||||
run: mkdocs build
|
||||
|
||||
- name: Upload artifact
|
||||
uses: actions/upload-pages-artifact@v3
|
||||
with:
|
||||
path: "site"
|
||||
|
||||
- name: Deploy to GitHub Pages
|
||||
id: deployment
|
||||
uses: actions/deploy-pages@v4
|
||||
10
.github/workflows/tests.yml
vendored
10
.github/workflows/tests.yml
vendored
@@ -21,7 +21,8 @@ jobs:
|
||||
run: ./generate-env.sh .env.test
|
||||
|
||||
- name: Build test images
|
||||
run: docker compose --env-file .env.test -f docker-compose.test.yaml build
|
||||
run:
|
||||
docker compose --env-file .env.test -f docker-compose.test.yaml build
|
||||
|
||||
- name: Run tests
|
||||
run: |
|
||||
@@ -43,7 +44,8 @@ jobs:
|
||||
|
||||
- name: Show service logs on failure
|
||||
if: failure()
|
||||
run: docker compose --env-file .env.test -f docker-compose.test.yaml logs
|
||||
run:
|
||||
docker compose --env-file .env.test -f docker-compose.test.yaml logs
|
||||
|
||||
- name: Upload test results
|
||||
if: always()
|
||||
@@ -54,4 +56,6 @@ jobs:
|
||||
|
||||
- name: Tear down
|
||||
if: always()
|
||||
run: docker compose --env-file .env.test -f docker-compose.test.yaml down -v
|
||||
run:
|
||||
docker compose --env-file .env.test -f docker-compose.test.yaml down
|
||||
-v
|
||||
|
||||
Reference in New Issue
Block a user