diff --git a/CHANGELOG.md b/CHANGELOG.md index 801b852..b804981 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), ## [Unreleased] +## [0.6.1] - 2026-10-23 + +The `v0.6.0` tag was created without the version bump and changelog update, so it should not be used. This release +contains the changes intended for 0.6.0. + ### Added - Repeatable `--exclude` support for `mps-check-orphan-modules` and `mps-check-orphan-models`. Each is a @@ -84,7 +89,8 @@ Initial release. - `mps-check-module-naming` - `mps-check-path-variables` / `mps-fix-path-variables` -[Unreleased]: https://github.com/specificlanguages/mps-pre-commit-hooks/compare/v0.5.0...HEAD +[Unreleased]: https://github.com/specificlanguages/mps-pre-commit-hooks/compare/v0.6.1...HEAD +[0.6.1]: https://github.com/specificlanguages/mps-pre-commit-hooks/compare/v0.5.0...v0.6.1 [0.5.0]: https://github.com/specificlanguages/mps-pre-commit-hooks/compare/v0.4.0...v0.5.0 [0.4.0]: https://github.com/specificlanguages/mps-pre-commit-hooks/compare/v0.3.0...v0.4.0 [0.3.0]: https://github.com/specificlanguages/mps-pre-commit-hooks/compare/v0.2.0...v0.3.0 diff --git a/README.md b/README.md index b1a925e..2e58406 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Add the repo to your project's `.pre-commit-config.yaml`: ```yaml repos: - repo: https://github.com/specificlanguages/mps-pre-commit-hooks - rev: v0.5.0 + rev: v0.6.1 hooks: - id: mps-check-orphan-modules - id: mps-check-unbuilt-modules diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 0000000..2b129ae --- /dev/null +++ b/RELEASING.md @@ -0,0 +1,31 @@ +# Releasing + +Releases are Git tags named `vX.Y.Z`. Users pin the tag through `rev:` in their `.pre-commit-config.yaml`, so the tag +must point at a commit that already contains the version bump and the changelog entry. + +1. Start from an up-to-date `main` (or a branch that will be merged into `main` before tagging). +2. Choose the new version following [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +3. Update `CHANGELOG.md`: + - Rename the `[Unreleased]` entries into a new `## [X.Y.Z] - YYYY-MM-DD` section and leave an empty `## [Unreleased]` + above it. + - Update the link references at the bottom: `[Unreleased]` compares `vX.Y.Z...HEAD`, and add `[X.Y.Z]` comparing the + previous tag with `vX.Y.Z`. +4. Set `version` in `pyproject.toml` to `X.Y.Z`. +5. Run `uv lock` so the `mps-pre-commit-hooks` entry in `uv.lock` gets the new version. +6. Update `rev:` in the usage example in `README.md` to `vX.Y.Z`. +7. Run the checks: + + ```bash + uv run pytest + ``` + +8. Commit as `Bump version to X.Y.Z`, push, and merge to `main`. +9. Tag the merge commit on `main` and push the tag: + + ```bash + git tag -a vX.Y.Z -m "Release X.Y.Z" + git push origin vX.Y.Z + ``` + +Never move or delete a tag after pushing it, since users may already have it cached. If a tag was created too early, +release the next patch version instead and mention it in the changelog. diff --git a/pyproject.toml b/pyproject.toml index bde6de8..c856cac 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "mps-pre-commit-hooks" -version = "0.5.0" +version = "0.6.1" description = "Pre-commit hooks for JetBrains MPS projects" readme = "README.md" requires-python = ">=3.13" diff --git a/uv.lock b/uv.lock index 9054bcb..ac71186 100644 --- a/uv.lock +++ b/uv.lock @@ -22,7 +22,7 @@ wheels = [ [[package]] name = "mps-pre-commit-hooks" -version = "0.5.0" +version = "0.6.1" source = { editable = "." } dependencies = [ { name = "pre-commit-hooks" },