Skip to content

Remove automatic README version update from release workflow #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexec merged 2 commits into from
Nov 17, 2025
Merged

Remove automatic README version update from release workflow #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4df3e68
Initial plan
Copilot Nov 17, 2025
525376a
Remove automatic README version update from release workflow
Copilot Nov 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 0 additions & 24 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,30 +19,6 @@ jobs:
token: ${{ secrets.GITHUB_TOKEN }}
- run: git fetch --force --tags

- name: Update README version
run: |
# Checkout main branch to commit changes
git checkout main

# Update README with the new version
./scripts/update-readme-version.sh ${{ github.ref_name }}

# Configure git
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"

# Commit and push if there are changes
git add README.md
if ! git diff --staged --quiet; then
git commit -m "Update README to version ${{ github.ref_name }}"
git push origin main
else
echo "No changes to README.md"
fi

# Checkout the tag again for the build
git checkout ${{ github.ref_name }}

- name: Set up Go
uses: actions/setup-go@v3
with:
Expand Down
21 changes: 9 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,21 +268,18 @@ Example MCP client configuration:

### Releasing a New Version

When you push a new tag (e.g., `v0.0.3`), the GitHub Actions release workflow will automatically:

1. Update all version references in this README.md
2. Commit the updated README back to the main branch
3. Build binaries for all supported platforms
4. Create a GitHub release with the built binaries and checksums

To create a new release:

```bash
git tag v0.0.3
git push origin v0.0.3
```
1. Update version references in README.md (installation instructions)
2. Create and push a tag:
```bash
git tag v0.0.3
git push origin v0.0.3
```

The README will be automatically updated with the new version number in all installation instructions.
The GitHub Actions release workflow will automatically:
- Build binaries for all supported platforms
- Create a GitHub release with the built binaries and checksums

## License

Expand Down