From 28ec85fed381571f024ab965cbae5090253f2ea1 Mon Sep 17 00:00:00 2001 From: Luc Didry Date: Wed, 15 Jan 2025 16:15:16 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20=E2=80=94=20Improve=20release=20?= =?UTF-8?q?documentation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CHANGELOG.md | 1 + docs/developer/release.md | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6d92cb2..4cb5250 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,7 @@ - 🩹 — Avoid warning from MySQL only alembic instructions - 🩹 — Check before adding/removing ip_version_enum +- 📝 — Improve release documentation ## 0.7.0 diff --git a/docs/developer/release.md b/docs/developer/release.md index d5122c5..089b697 100644 --- a/docs/developer/release.md +++ b/docs/developer/release.md @@ -41,7 +41,8 @@ git add argos/__init__.py CHANGELOG.md git commit -m "🏷 — Bump version ($(hatch version))" # Create a tag on the git repository and push it -git tag "$(hatch version)" && git push +git tag "$(hatch version)" -m "$(hatch version)" && + git push --follow-tags # Build the project hatch build --clean