📝 Docs: Create CHANGELOG.md using git-changelog (#38) #211
This file contains hidden or 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: Python package | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| branches: [main] | |
| release: | |
| types: [published] | |
| jobs: | |
| format: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: psf/black@stable | |
| lint: | |
| name: Lint with ruff | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.11" | |
| - name: Install ruff | |
| run: | | |
| pip install ruff | |
| - name: Lint with ruff | |
| run: | | |
| ruff check src | |
| test: | |
| name: Test | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ["3.11", "3.12", "3.13"] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| cache: 'pip' # caching pip dependencies | |
| cache-dependency-path: '**/pyproject.toml' | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install pytest | |
| pip install -e . | |
| - name: Run tests | |
| run: python -m pytest tests | |
| changelog: | |
| name: Update changelog | |
| if: github.event_name == 'release' && github.event.action == 'published' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout main branch | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: main | |
| - name: Update CHANGELOG.md | |
| uses: rhysd/changelog-from-release/action@v3 | |
| with: | |
| file: CHANGELOG.md | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| header: | | |
| # Release Notes | |
| All notable changes to this project are documented in this file. It was automatically generated with | |
| the [changelog-from-release](https://github.com/rhysd/changelog-from-release) tool. | |
| publish: | |
| name: Publish package | |
| if: startsWith(github.ref, 'refs/tags') | |
| permissions: | |
| id-token: write | |
| needs: | |
| - test | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.11" | |
| - name: Install twine and build | |
| run: python -m pip install --upgrade twine build | |
| - name: Build | |
| run: python -m build | |
| - name: Publish package distributions to PyPI | |
| uses: pypa/gh-action-pypi-publish@release/v1 |