Skip to content

docs(readme): update installation instructions and badges (#402) #48

docs(readme): update installation instructions and badges (#402)

docs(readme): update installation instructions and badges (#402) #48

Workflow file for this run

name: push
on:
push:
branches: main
env:
PYTHON_VERSION: "3.11"
UV_VERSION: "0.5.13"
jobs:
docs-deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
persist-credentials: false
- uses: actions/setup-python@v5
with:
python-version: "3.9"
architecture: x64
- uses: astral-sh/setup-uv@v5
with:
version: ${{ env.UV_VERSION }}
- name: Build documentation
run: |
make install-docs
make docs-full
- name: Documentation sanity check
run: test -e docs/build/index.html || exit
- name: Install SSH Client 🔑
uses: webfactory/ssh-agent@v0.9.0
with:
ssh-private-key: ${{ secrets.SSH_DEPLOY_KEY }}
- name: Deploy to Github Pages
uses: JamesIves/github-pages-deploy-action@v4.7.2
with:
branch: gh-pages
folder: docs/build
commit-message: '[skip ci] Documentation updates'
clean: true
dockerhub:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: astral-sh/setup-uv@v5
with:
version: ${{ env.UV_VERSION }}
- name: Build docker image
run: make build-api
- name: Login to GHCR
uses: docker/login-action@v3
with:
registry: ghcr.io
username: ${{ github.repository_owner }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Push to GitHub container registry
run: |
docker tag holocron/backend:latest ghcr.io/${{ github.repository_owner }}/holocron:latest
docker push ghcr.io/${{ github.repository_owner }}/holocron:latest