Skip to content

docs: update README and utility function for consistency #93

docs: update README and utility function for consistency

docs: update README and utility function for consistency #93

Workflow file for this run

name: CI
on:
push:
release:
types:
- published
jobs:
build:
name: Build
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup uv
uses: astral-sh/setup-uv@v4
- name: Install Dependencies
run: uv sync --all-extras
- name: Build
run: uv build
- name: Upload Artifacts
uses: actions/upload-artifact@v4
with:
name: dist
path: dist/
release:
name: Release
permissions:
id-token: write
needs:
- build
if: github.event_name == 'release'
runs-on: ubuntu-latest
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
steps:
- name: Download Artifacts
uses: actions/download-artifact@v4
with:
name: dist
path: dist/
- name: Publish to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
pre-release:
name: Pre-Release
permissions:
contents: write
needs:
- build
if: github.ref == 'refs/heads/main'
runs-on: ubuntu-latest
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
steps:
- name: Download Artifacts
uses: actions/download-artifact@v4
with:
name: dist
path: dist/
- name: Create GitHub Release
uses: liblaf/actions/release@main
with:
clobber: true
files: dist/*
prerelease: true
tag: latest