Skip to content

Commit f1824c4

Browse files
Refine git add to only include README.md and clarify documentation
Co-authored-by: thomasturrell <1552612+thomasturrell@users.noreply.github.com>
1 parent 7364adb commit f1824c4

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

.github/workflows/manual-release.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -198,8 +198,8 @@ jobs:
198198
echo "Documentation examples updated with release version"
199199
200200
# Amend the release commit created by release:prepare to include doc updates
201-
# Add all modified files that the script may have updated
202-
git add -u
201+
# Only add README.md since that's what the script updates
202+
git add README.md
203203
git commit --amend --no-edit
204204
205205
# Update the tag to point to the amended commit

RELEASING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Result:
118118
1. Check the [Actions tab](https://github.com/BerryCloud/xapi-java/actions) to ensure the workflow completed successfully
119119
- The workflow will show a summary of the release including version, tag, and status
120120
2. Verify the target branch (e.g., `main`) has two new commits:
121-
- Release commit: `[maven-release-plugin] prepare release vX.Y.Z` (includes documentation updates)
121+
- Release commit: `[maven-release-plugin] prepare release vX.Y.Z` (amended to include documentation updates)
122122
- Development commit: `[maven-release-plugin] prepare for next development iteration`
123123
3. Verify the GitHub Release was published at the [Releases page](https://github.com/BerryCloud/xapi-java/releases)
124124
- The release should no longer be in draft state

0 commit comments

Comments
 (0)