chore: upgrade checkout (#346) #2
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Release | |
"on": | |
push: | |
branches: ["main", "master"] | |
workflow_dispatch: | |
inputs: | |
release_force: | |
description: | | |
Force release be one of: [major | minor | patch] | |
Leave empty for auto-detect based on commit messages. | |
type: choice | |
options: | |
- "" # auto-detect | |
- major # force major | |
- minor # force minor | |
- patch # force patch | |
default: "" | |
required: false | |
prerelease_token: | |
description: | | |
'The "prerelease identifier" to use as a prefix for the "prerelease" \ | |
part of a semver. Like the rc in `1.2.0-rc.8`.' | |
type: choice | |
options: | |
- rc | |
- beta | |
- alpha | |
default: rc | |
required: false | |
prerelease: | |
description: "Is a pre-release" | |
type: boolean | |
default: false | |
required: false | |
concurrency: | |
group: deploy | |
cancel-in-progress: false # prevent hickups with semantic-release | |
env: | |
PYTHON_VERSION_DEFAULT: "3.10.8" | |
jobs: | |
Test: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
fetch-depth: 1 | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: ${{ env.PYTHON_VERSION_DEFAULT }} | |
- name: Install and configure Poetry | |
uses: snok/install-poetry@v1 | |
with: | |
virtualenvs-create: true | |
virtualenvs-in-project: true | |
installer-parallel: true | |
- name: Load cached venv | |
id: cached-poetry-dependencies | |
uses: actions/cache@v3 | |
with: | |
path: .venv | |
key: | | |
venv-${{ runner.os }}-\ | |
${{ env.PYTHON_VERSION_DEFAULT }}-\ | |
${{ hashFiles('**/poetry.lock') }} | |
- name: Validate project dependencies | |
run: poetry check | |
- name: Install dependencies | |
if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true' | |
run: poetry install --no-interaction --no-root | |
- name: Install library | |
run: poetry install --no-interaction | |
- name: Check dependencies | |
run: poetry run deptry . | |
- name: Run tests | |
run: poetry run pytest | |
Release: | |
needs: Test | |
if: "!contains(github.event.head_commit.message, 'chore(release):')" | |
runs-on: ubuntu-latest | |
permissions: | |
# NOTE: this enables trusted publishing. | |
# See https://github.com/pypa/gh-action-pypi-publish/tree/release/v1#trusted-publishing | |
# and https://blog.pypi.org/posts/2023-04-20-introducing-trusted-publishers/ | |
id-token: write | |
contents: write | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
token: ${{ secrets.OTG_ETL_RELEASE }} | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: ${{ env.PYTHON_VERSION_DEFAULT }} | |
- name: Install and configure Poetry | |
uses: snok/install-poetry@v1 | |
with: | |
virtualenvs-create: true | |
virtualenvs-in-project: true | |
installer-parallel: true | |
- name: Load cached venv | |
id: cached-poetry-dependencies | |
uses: actions/cache@v3 | |
with: | |
path: .venv | |
key: | | |
venv-${{ runner.os }}-\ | |
${{ env.PYTHON_VERSION_DEFAULT }}-\ | |
${{ hashFiles('**/poetry.lock') }} | |
- name: Validate project dependencies | |
run: poetry check | |
- name: Install dependencies | |
if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true' | |
run: poetry install --no-interaction --no-root | |
- name: Python Semantic Release | |
id: release | |
# see https://python-semantic-release.readthedocs.io/en/latest/automatic-releases/github-actions.html | |
# see https://github.com/python-semantic-release/python-semantic-release | |
uses: python-semantic-release/[email protected] | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
force: ${{ github.event.inputs.release_force }} | |
prerelease: ${{ github.event.inputs.prerelease }} | |
prerelease_token: ${{ github.event.inputs.prerelease_token }} | |
Documentation: | |
needs: Release | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
token: ${{ secrets.OTG_ETL_RELEASE }} | |
- name: Set up Python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: ${{ env.PYTHON_VERSION_DEFAULT }} | |
- name: Install and configure Poetry | |
uses: snok/install-poetry@v1 | |
with: | |
virtualenvs-create: true | |
virtualenvs-in-project: true | |
installer-parallel: true | |
- name: Load cached venv | |
id: cached-poetry-dependencies | |
uses: actions/cache@v3 | |
with: | |
path: .venv | |
key: | | |
venv-${{ runner.os }}-\ | |
${{ env.PYTHON_VERSION_DEFAULT }}-\ | |
${{ hashFiles('**/poetry.lock') }} | |
- name: Install dependencies | |
if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true' | |
run: poetry install --no-interaction --no-root | |
- name: Install library | |
run: poetry install --without tests --no-interaction | |
- name: Publish docs | |
run: poetry run mkdocs gh-deploy --force |