Skip to content

Commit

Permalink
Added github workflows
Browse files Browse the repository at this point in the history
  • Loading branch information
couling committed Nov 3, 2024
1 parent 4e52ca1 commit 0878e16
Show file tree
Hide file tree
Showing 6 changed files with 145 additions and 45 deletions.
20 changes: 20 additions & 0 deletions .github/release.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
changelog:
exclude:
labels:
- dont-mention
categories:
- title: ⚠️ Breaking Changes
labels:
- breaking-change
- title: ⚙️ New Features
labels:
- enhancement
- title: 🐛 Bugfixes
labels:
- bug
- title: 💋 Cosmetic Changes
labels:
- cosmetic
- title: Other Changes
labels:
- "*"
32 changes: 32 additions & 0 deletions .github/workflows/pull_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Pull Request
on:
pull_request: {}

jobs:
test:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]

steps:
- uses: actions/checkout@v4

- name: Install poetry
run: pipx install poetry

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
cache: poetry

- name: Install Project and Test Dependencies
run: poetry install --only test,main

- name: Pytest
run: poetry run pytest

- name: MyPy
run: poetry run mypy
77 changes: 77 additions & 0 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
name: Release Request
on:
release:
types: ["published"]

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Install poetry
run: pipx install poetry

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
cache: poetry

- name: Set Project Version
shell: bash
run: |
version_ref="${{github.ref}}"
poetry version "${version_ref#refs/tags/}"
- name: Build
run: poetry build

- name: Upload Artifact
uses: actions/upload-artifact@v4
with:
name: dist
path: dist/


attach-to-release:
needs: build
runs-on: ubuntu-latest

permissions:
contents: write

steps:
- uses: actions/download-artifact@v4
with:
name: dist
path: dist

- name: Publish to GitHub release page
uses: svenstaro/upload-release-action@v2
with:
repo_token: ${{ secrets.GITHUB_TOKEN }}
file: "dist/*"
file_glob: true
tag: ${{ github.ref }}


upload-to-pypi:
needs: build
runs-on: ubuntu-latest

environment:
name: pypi
url: https://pypi.org/p/dataclass-click

permissions:
id-token: write

steps:
- uses: actions/download-artifact@v4
with:
name: dist
path: dist

- name: Upload to Pypi
uses: pypa/gh-action-pypi-publish@release/v1
4 changes: 2 additions & 2 deletions mkdocs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ determine which plugin is to blame before posting issues here or [there](https:/

## Features

It's advantages over the [mkdocstrings-python recopy](https://mkdocstrings.github.io/recipes/#automatic-code-reference-pages) are:
Its advantages over the [mkdocstrings-python recipe](https://mkdocstrings.github.io/recipes/#automatic-code-reference-pages) are:

- ✅ Easier to use (no writing code for yourself)
- ✅ Well formatted nav out of the box. Package names with underscores are not title case 📦
- ✅ Compatibility with both explicit nav defined in mkdocs.yaml and implicit nav with no definition in mkdocs.yaml
- ✅ Supports __init__.py files as [section indexes](https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#section-index-pages) if supported by the theme.
- ✅ Supports `__init__.py` files as [section indexes](https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#section-index-pages) if supported by the theme.
- ✅ Edit URI compatible with both `edit_uri` and `edit_uri_template`

## Minimal Example
Expand Down
Loading

0 comments on commit 0878e16

Please sign in to comment.