Skip to content

Clnt-50: Try to manually release the documentation #119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
benglewis merged 5 commits into from
Jun 12, 2025
Merged

Clnt-50: Try to manually release the documentation #119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a1bfd01
Try to manually release the documentation
benglewis May 16, 2025
20254a5
Fix tests being unable to complete due to previous successful runs of…
benglewis May 25, 2025
3090852
Fix bug found by bugbot (thank you Cursor)
benglewis Jun 11, 2025
4c3067f
Fix bug found by bugbot (thank you Cursor)
benglewis Jun 11, 2025
d103b71
Fix bug found by bugbot (thank you Cursor)
benglewis Jun 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/pytest-sanity.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ jobs:
AWS_ACCESS_KEY: ${{ secrets.AWS_ACCESS_KEY }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
HUGGINGFACE_ACCESS_TOKEN: ${{ secrets.HUGGINGFACE_ACCESS_TOKEN }}
UNIQUE_ID: ${{ matrix.os }}-${{ matrix.python-version }}-${{ github.run_number }}
UNIQUE_ID: ${{ matrix.os }}-${{ matrix.python-version }}-${{ github.run_number }}-${{ github.run_attempt }}
FULL_TEST: ${{ (matrix.os == 'ubuntu-latest' && matrix.python-version == '3.9') && 'true' || 'false' }}
- name: Run PyTest on Windows
if: runner.os == 'Windows'
Expand All @@ -62,5 +62,5 @@ jobs:
AWS_ACCESS_KEY: ${{ secrets.AWS_ACCESS_KEY }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
HUGGINGFACE_ACCESS_TOKEN: ${{ secrets.HUGGINGFACE_ACCESS_TOKEN }}
UNIQUE_ID: ${{ matrix.os }}-${{ matrix.python-version }}-${{ github.run_number }}
UNIQUE_ID: ${{ matrix.os }}-${{ matrix.python-version }}-${{ github.run_number }}-${{ github.run_attempt }}
FULL_TEST: false
88 changes: 50 additions & 38 deletions .github/workflows/update-docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@ on:
pull_request:
types: [closed]
paths:
- 'hirundo/__init__.py'
- "hirundo/__init__.py"
push:
branches:
- clnt-50-fix-docs

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
Expand All @@ -25,40 +28,49 @@ jobs:
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0 # Fetch all history for all tags and branches
- uses: actions/setup-python@v3
with:
python-version: "3.9"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m venv .venv
source .venv/bin/activate
pip install -r requirements/docs.txt
export VERSION_TAG=${{ github.event.pull_request.title }}
export VERSION=$(sed -e 's/^v//' <<< $VERSION_TAG)
pip install "hirundo==${VERSION}"
- name: Sphinx multi-version build
run: |
source .venv/bin/activate
git branch -a
git tag
git rev-parse --abbrev-ref HEAD
git rev-parse HEAD
sphinx-multiversion docs docs/_build/html
cp docs/_templates/github-pages-redirect.html docs/_build/html/index.html
env:
API_HOST: something
API_KEY: something
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: "docs/_build/html"
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0 # Fetch all history for all tags and branches
- uses: actions/setup-python@v3
with:
python-version: "3.9"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m venv .venv
source .venv/bin/activate
pip install -r requirements/docs.txt
# Extract version from hirundo/__init__.py with error handling
if [ -f "hirundo/__init__.py" ]; then
export VERSION=$(python -c "import re; content=open('hirundo/__init__.py').read(); match=re.search(r'__version__ = [\"\'](.*?)[\"\']', content); print(match.group(1) if match else 'unknown')" 2>/dev/null || echo 'unknown')
else
export VERSION='unknown'
fi
echo "Using version: $VERSION"
if [ "$VERSION" = "unknown" ] || [ -z "$VERSION" ]; then
echo "Error: Could not extract version from hirundo/__init__.py (file may be missing, unreadable, or version format is invalid)"
exit 1
fi
pip install "hirundo==${VERSION}"
- name: Sphinx multi-version build
run: |
source .venv/bin/activate
git branch -a
git tag
git rev-parse --abbrev-ref HEAD
git rev-parse HEAD
sphinx-multiversion docs docs/_build/html
cp docs/_templates/github-pages-redirect.html docs/_build/html/index.html
env:
API_HOST: something
API_KEY: something
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: "docs/_build/html"
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4