CI/FIX: improve and fix actions

[skip-pytest]

.github/workflows/docs.yml

@@ -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 ]
 
@@ -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:
@@ -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
@@ -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

.github/workflows/tests.yml

@@ -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
@@ -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:
@@ -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
 
@@ -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