Skip to content

Commit

Permalink
Change release environment and remove prettier
Browse files Browse the repository at this point in the history
* update contributing guide to add description for version number when
  release
* change `production` environment to `release` environment in github
  release workflow
* remove prettier from pre-commit
  • Loading branch information
kiraware committed Sep 15, 2024
1 parent 9780cc1 commit 21a773e
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 11 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 0 additions & 8 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
5 changes: 3 additions & 2 deletions docs/how-to-guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 21a773e

Please sign in to comment.