feat(entities): Make models their own entity #6
Workflow file for this run
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
# Workflow that runs on closed PRs to the default branch | |
name: Default Branch PR Merged CI (Python) | |
on: | |
pull_request: | |
types: ["closed"] | |
branches: ["main"] | |
# Specify concurrency such that only one workflow can run at a time | |
# * Different workflow files are not affected | |
concurrency: | |
group: ${{ github.workflow }}-${{ github.ref }} | |
cancel-in-progress: false | |
env: | |
REGISTRY: ghcr.io | |
IMAGE_NAME: ${{ github.repository }} | |
jobs: | |
# Define an autotagger job that creates tags on changes to master | |
# Use #major #minor in merge commit messages to bump version beyond patch | |
bump-tag: | |
runs-on: ubuntu-latest | |
if: | | |
github.event_name == 'pull_request' && | |
github.event.action == 'closed' && | |
github.event.pull_request.merged == true | |
permissions: | |
contents: write | |
outputs: | |
tag: ${{ steps.tag.outputs.tag }} | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- name: Bump version and push tag | |
uses: anothrNick/github-tag-action@1.67.0 | |
id: tag | |
env: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
RELEASE_BRANCHES: main | |
WITH_V: true | |
DEFAULT_BUMP: patch | |
GIT_API_TAGGING: false | |
# Job for building container image | |
# * Builds and pushes an OCI Container image to the registry defined in the environment variables | |
build-container: | |
runs-on: ubuntu-latest | |
needs: bump-tag | |
permissions: | |
contents: read | |
packages: write | |
steps: | |
# Do a non-shallow clone of the repo to ensure tags are present | |
# * This allows setuptools-git-versioning to automatically set the version | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- name: Set up Buildx | |
uses: docker/setup-buildx-action@v3 | |
- name: Log in to the Container registry | |
uses: docker/login-action@v3 | |
with: | |
registry: ${{ env.REGISTRY }} | |
username: ${{ github.actor }} | |
password: ${{ secrets.GITHUB_TOKEN }} | |
# Tag the built image according to the event type | |
# The event is a semver release, so use the version | |
- name: Extract metadata (tags, labels) for Container | |
id: meta | |
uses: docker/metadata-action@v5 | |
with: | |
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} | |
tags: type=semver,pattern={{version}},value=${{ needs.bump-tag.outputs.tag }} | |
# Build and push the Container image to the registry | |
# * Creates a multiplatform-aware image | |
# * Pulls build cache from the registry and pushes new cache back | |
- name: Build and push container image | |
uses: docker/build-push-action@v6 | |
with: | |
context: . | |
file: Containerfile | |
push: true | |
tags: ${{ steps.meta.outputs.tags }} | |
labels: ${{ steps.meta.outputs.labels }} | |
platforms: linux/amd64 | |
cache-from: type=registry,ref=${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:buildcache | |
cache-to: type=registry,ref=${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:buildcache,mode=max | |
# Job to build and publish the package on PyPi as a wheel | |
build-wheel: | |
runs-on: ubuntu-latest | |
needs: bump-tag | |
steps: | |
# Do a non-shallow clone of the repo to ensure tags are present | |
# * This allows setuptools-git-versioning to automatically set the version | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- name: Setup uv | |
uses: astral-sh/setup-uv@v3 | |
with: | |
enable-cache: true | |
cache-dependency-glob: "pyproject.toml" | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version-file: "pyproject.toml" | |
- name: Install editable package and required dependencies | |
run: uv sync --no-dev | |
# Building the wheel dynamically assigns the version according to git | |
# * The setuptools_git_versioning package reads the git tags and assigns the version | |
# * The version is then used in the wheel filename and made available in the package | |
# * setuptools_git_versioning is configured in pyproject.toml | |
- name: Build wheel | |
run: uv build --wheel . | |
- name: Upload wheel | |
uses: actions/upload-artifact@v4 | |
with: | |
name: wheel | |
path: dist/*.whl | |
- name: Publish wheel | |
uses: pypa/gh-action-pypi-publish@release/v1 | |
with: | |
user: __token__ | |
password: ${{ secrets.PYPI_API_TOKEN }} | |
# Define a job that builds the documentation | |
# * Surfaces the documentation as an artifact | |
build-docs: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
- name: Setup uv | |
uses: astral-sh/setup-uv@v3 | |
with: | |
enable-cache: true | |
cache-dependency-glob: "pyproject.toml" | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version-file: "pyproject.toml" | |
- name: Install editable package and required dependencies | |
run: uv sync | |
# Pydoctor is ran to find any linking errors in the docs | |
- name: Build documentation | |
run: | | |
uv run pydoctor --html-output=tmpdocs -W -q | |
PDOC_ALLOW_EXEC=1 uv run pdoc -o docs \ | |
--docformat=google \ | |
--logo="https://cdn.prod.website-files.com/62d92550f6774db58d441cca/6324a2038936ecda71599a8b_OCF_Logo_black_trans.png" \ | |
src/nwp_consumer | |
- name: Upload documentation artifact | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
path: docs/ | |
# Job to deploy the documentation to GitHub pages | |
deploy-docs: | |
needs: build-docs | |
runs-on: ubuntu-latest | |
permissions: | |
pages: write | |
id-token: write | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
steps: | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 | |