diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 63521dc..45c40a5 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -11,7 +11,7 @@ jobs: contents: read id-token: write runs-on: ubuntu-latest - environment: production + environment: release steps: - name: Checkout source code uses: actions/checkout@v4 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index b73e109..09af989 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -49,14 +49,6 @@ repos: types: [python] pass_filenames: false - # prettier - formatting Markdown - - repo: https://github.com/pre-commit/mirrors-prettier - rev: v4.0.0-alpha.8 - hooks: - - id: prettier - types: [text, markdown] - exclude: ^poetry.lock - # mkdocs - build the documentation - repo: local hooks: diff --git a/docs/how-to-guides.md b/docs/how-to-guides.md index 9734e98..6e3045b 100644 --- a/docs/how-to-guides.md +++ b/docs/how-to-guides.md @@ -132,6 +132,7 @@ poetry run mkdocs serve We use the GitHub workflow to automatically release to PyPI when we release to GitHub. The special environment for people who have access -to the workflow is in the GitHub environment with the name `production`. +to the workflow is in the GitHub environment with the name `release`. Each release tag must be the same as `version` in `pyproject.toml` in -the `tool.poetry` section. +the `tool.poetry` section with prefix `v`, for example `v1.0.0`. Also +we follow Semantic Versioning with version number MAJOR.MINOR.PATCH.