Skip to content

Commit

Permalink
CI/FIX: improve and fix actions
Browse files Browse the repository at this point in the history
[skip-pytest]
  • Loading branch information
theOehrly committed Jul 30, 2024
1 parent c8bc192 commit 9b5a994
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 16 deletions.
35 changes: 30 additions & 5 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,15 @@ name: Build Documentation

on:
workflow_dispatch:
workflow_call:
inputs:
publish:
required: true
type: boolean
pin-tag:
# pin-tag can be used to keep the latest X.Y.Z release tag instead of
# a X.Y.Z-devN tag when updating the docs after a release
required: false
type: string
release:
types: [ released ]

Expand All @@ -18,6 +22,7 @@ env:

jobs:
build_docs:
if: (!contains(github.event.head_commit.message, '[skip-doc-build]')) || inputs.publish
name: Build Documentation
runs-on: ubuntu-latest
steps:
Expand Down Expand Up @@ -58,10 +63,20 @@ jobs:
restore-keys: |
fastf1-doc-cache
- name: Install at pinned tag
if: inputs.fake-tag
run: |
git checkout ${{ inputs.fake-tag }}
- name: Install Fast-F1 from sources
run: |
python -m pip install -e .
- name: Re-checkout current commit after install at pinned tag
if: inputs.fake-tag
run: |
git checkout ${{ github.sha }}
- name: Create doc build dir
run: |
mkdir -p docs/_build/html
Expand All @@ -75,18 +90,28 @@ jobs:
- name: Build docs
run: |
mkdir test_cache # not really need but pytest setup relies on it
cd ./docs
make clean
# delete all files in build directory, will be replaced with new
# build (don't use "make clean" as it deletes the .git folder)
# need to go to nested git repository in build directory
cd ./docs/_build/html
git rm -r *
# go back to docs folder in main repository
cd ../..
make html
- name: Publish docs
if: (github.event_name == 'release') || inputs.publish
- name: Prepare docs for publishing
run: |
cd docs/_build/html
git add .
git config user.name github-actions
git config user.email [email protected]
git commit -m "$GITHUB_REF_NAME ($GITHUB_JOB) ci release"
- name: Publish docs
if: (github.event_name == 'release') || inputs.publish
run: |
git push origin gh-pages --force
- name: Upload docs as artifact
Expand Down
11 changes: 0 additions & 11 deletions .github/workflows/publish_docs.yml

This file was deleted.

4 changes: 4 additions & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ env:

jobs:
run-code-tests:
if: (!contains(github.event.head_commit.message, '[skip-pytest]'))
runs-on: ubuntu-latest
strategy:
fail-fast: false
Expand Down Expand Up @@ -75,6 +76,7 @@ jobs:
run-lint-checks:
if: (!contains(github.event.head_commit.message, '[skip-ruff]'))
runs-on: ubuntu-latest
name: Linting (Ruff)
steps:
Expand Down Expand Up @@ -111,6 +113,7 @@ jobs:
run-isort-test:
if: (!contains(github.event.head_commit.message, '[skip-isort]'))
name: Test import order (isort)
runs-on: ubuntu-latest

Expand Down Expand Up @@ -141,6 +144,7 @@ jobs:
python -m isort . --check-only
run-readme-render-test:
if: (!contains(github.event.head_commit.message, '[skip-readme-test]'))
name: Test readme renders on PyPi
runs-on: ubuntu-latest

Expand Down

0 comments on commit 9b5a994

Please sign in to comment.