From c37619d5ad072e2c9b25e4ba02cebce852c6b416 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Marcos?= Date: Mon, 31 Aug 2026 00:05:42 -0300 Subject: [PATCH 1/2] rename changelog, remove stale reference --- CHANGELOG.md => OLD_CHANGELOG | 0 scripts/DRAFT_NEW_RELEASE.md | 20 +++++++------------- 2 files changed, 7 insertions(+), 13 deletions(-) rename CHANGELOG.md => OLD_CHANGELOG (100%) diff --git a/CHANGELOG.md b/OLD_CHANGELOG similarity index 100% rename from CHANGELOG.md rename to OLD_CHANGELOG diff --git a/scripts/DRAFT_NEW_RELEASE.md b/scripts/DRAFT_NEW_RELEASE.md index a0bdf579e..b56d234f3 100644 --- a/scripts/DRAFT_NEW_RELEASE.md +++ b/scripts/DRAFT_NEW_RELEASE.md @@ -27,19 +27,13 @@ The version must be in `MAJOR.MINOR.PATCH` format. The script will: -1. Update the top of `CHANGELOG.md`: - - point `Unreleased` at `NEW_VERSION...HEAD` - - add fresh empty sections for the next development cycle - - create a `NEW_VERSION` changelog section comparing the previous version to `NEW_VERSION` -2. Ask you to review `CHANGELOG.md`. - - You should enter `y` to proceed. -3. Update the package version in `Cargo.toml`. -4. Run `cargo test --profile fast`, which will also update `Cargo.lock`. -5. Commit `CHANGELOG.md`, `Cargo.toml`, and `Cargo.lock` with: +1. Update the package version in `Cargo.toml`. +2. Run `cargo test --profile fast`, which will also update `Cargo.lock`. +3. Commit `Cargo.toml` and `Cargo.lock` with new version: - Message: `"bump version NEW_VERSION"`. -6. Create new release candidate tag, like `NEW_VERSION-rc1`, `NEW_VERSION-rc2`, etc. -7. Push tags. -8. Print the GitHub Actions URL. +4. Create new release candidate tag, like `NEW_VERSION-rc1`, `NEW_VERSION-rc2`, etc. +5. Push tags. +6. Print the GitHub Actions URL. ## After the script runs @@ -49,7 +43,7 @@ The script will: 3. Go to GitHub Releases: 4. Open the drafted release for the RC tag. -5. Continue polishing the release notes/changelog if needed. +5. Continue polishing the release notes if needed. 6. Publish to crates.io: ```sh cargo publish From a162d6f19804789e28c66e8bf4aee253a595fc1a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Marcos?= Date: Wed, 2 Sep 2026 10:57:51 -0300 Subject: [PATCH 2/2] remove CHANGELOG.md from release package assets --- scripts/package-release-assets.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/package-release-assets.sh b/scripts/package-release-assets.sh index 2d6d9b68f..19b9b448b 100755 --- a/scripts/package-release-assets.sh +++ b/scripts/package-release-assets.sh @@ -41,7 +41,7 @@ for platform in "${PLATFORMS[@]}"; do fi mv "${path}-${DEFAULT_FEATURES}" "$path" # remove the annoying suffix - cp ../{README.md,LICENSE,CHANGELOG.md} "$path" + cp ../{README.md,LICENSE} "$path" mkdir -p "$path/man" mkdir -p "$path/completions"