Copilot commented on code in PR #421:
URL: https://github.com/apache/fluss-rust/pull/421#discussion_r2878389859
##########
website/docs/release/create-release.md:
##########
@@ -77,12 +77,13 @@ cd fluss-rust
Set these once and use them in all following commands. (Bash syntax.)
```bash
-export RELEASE_VERSION="0.1.0"
-export RELEASE_TAG="v${RELEASE_VERSION}"
-export SVN_RELEASE_DIR="fluss-rust-${RELEASE_VERSION}"
+RELEASE_VERSION="0.1.0"
+SHORT_RELEASE_VERSION="0.1"
+RELEASE_TAG="v${RELEASE_VERSION}"
+SVN_RELEASE_DIR="fluss-rust-${RELEASE_VERSION}"
# Only set if there is a previous release (for compare link in DISCUSS /
release notes)
-export LAST_VERSION="0.0.9"
-export NEXT_VERSION="0.2.0"
+LAST_VERSION="0.0.9"
+NEXT_VERSION="0.2.0"
Review Comment:
This section is labeled "environment variables" and the intro says "Set
these once and use them in all following commands", but the snippet now sets
plain shell variables (no `export`) while later RC vars are still exported. To
avoid confusing copy/paste behavior and keep the doc consistent, either add
`export` back for these variables or update the heading/text to explicitly say
these are shell variables scoped to the current session (and make RC vars
consistent too). Also, requiring a manually maintained `SHORT_RELEASE_VERSION`
is error-prone; consider deriving it from `RELEASE_VERSION` (e.g., via bash
parameter expansion) so they can’t drift.
##########
website/docs/release/create-release.md:
##########
@@ -122,8 +123,8 @@ From `main`, create a release branch. All release artifacts
will be built from t
```bash
git checkout main
git pull
-git checkout -b release-${RELEASE_VERSION}
-git push origin release-${RELEASE_VERSION}
+git checkout -b release-${SHORT_RELEASE_VERSION}
+git push origin release-${SHORT_RELEASE_VERSION}
Review Comment:
The doc now creates/checks out `release-${SHORT_RELEASE_VERSION}` (e.g.
`release-0.1`), but later in this same guide there is still at least one
instruction that refers to the release branch as `release-${RELEASE_VERSION}`
(e.g. when selecting the target branch for the GitHub Release). Please update
the remaining references to match the new branch naming so readers don’t end up
targeting a non-existent branch.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
