feat: github release bot #100

lirenjie95 · 2025-07-27T02:13:04Z

Fixes #98

Automated Release Workflow:

.github/workflows/release.yml: Added a GitHub Actions workflow to handle automated releases triggered by version tags or manual dispatch. The workflow includes steps for building multi-platform artifacts, generating changelogs, publishing to crates.io, and uploading release assets.

Documentation Updates:

RELEASE.md: Added a comprehensive guide detailing the release process, including setup instructions, versioning conventions, and step-by-step workflows for automated and manual releases.

Version Management:

scripts/update-version.sh: Added a script to update version numbers in Cargo.toml files and synchronize dependencies across the workspace. The script supports both Go-style (v1.2.3) and Rust-style (1.2.3) version formats.

- Improve cargo publish error handling with proper logging - Fix sed path separator consistency in update-version.sh - Add reusable check_and_copy function for file operations - Keep [email protected] (verified as latest version)

…ggestion - Use Go-style versioning (v1.2.3) as primary format for Git tags - Automatically convert between Go format (v1.2.3) and Rust format (1.2.3) - Update release workflow to handle both version formats correctly - Enhanced release notes with installation instructions for both ecosystems - Update version script to accept both formats with automatic detection - Improve documentation with unified version management strategy This enables: - Go users: go get github.com/ihciah/[email protected] - Rust users: cargo add [email protected] - Consistent versioning across both ecosystems

Copilot

Pull Request Overview

This PR introduces an automated release system for the Rust2Go project, supporting both Go and Rust ecosystems with unified version management using Go-style versioning (v1.2.3) as the primary format.

Adds GitHub Actions workflow for automated releases triggered by version tags or manual dispatch
Provides comprehensive documentation for the release process including setup and workflow instructions
Implements a shell script for updating version numbers across the workspace with support for both Go and Rust version formats

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File	Description
`.github/workflows/release.yml`	GitHub Actions workflow for automated releases with multi-platform builds, changelog generation, and publishing to crates.io
`RELEASE.md`	Comprehensive documentation covering release processes, version management, and troubleshooting
`scripts/update-version.sh`	Shell script for updating version numbers in Cargo.toml files and synchronizing workspace dependencies

Comments suppressed due to low confidence (1)

scripts/update-version.sh

Copilot · 2025-07-27T03:43:39Z

scripts/update-version.sh

+            # Use simpler approach with variables to improve readability
+            pattern_basic="^$dep = { version = \"[^\"]*\", path = \"\\.\\.\\/$dep\" }"
+            replacement_basic="$dep = { version = \"$NEW_VERSION\", path = \"\\.\\.\\/$dep\" }"
+            sed -i.bak "s/$pattern_basic/$replacement_basic/" "$toml_file"


The sed patterns use complex regex with escaped characters that could be fragile. The pattern matching and replacement logic could fail if the Cargo.toml format varies slightly from the expected format. Consider using a more robust TOML parsing approach or adding validation to check if the replacement was successful.

Copilot · 2025-07-27T03:43:40Z

.github/workflows/release.yml

+          cargo publish -p rust2go-common
+          sleep 10
+          cargo publish -p rust2go-convert
+          sleep 10
+          cargo publish -p rust2go-macro
+          sleep 10
+          cargo publish -p rust2go-mem-ffi
+          sleep 10
+          cargo publish -p mem-ring
+          sleep 10
+          cargo publish -p rust2go-cli
+          sleep 10
+          cargo publish -p rust2go 


The hardcoded sleep intervals (10 seconds) between crate publishes may not be sufficient if crates.io is slow to process. Consider implementing a more robust retry mechanism or checking publication status before proceeding to the next crate.

Suggested change

cargo publish -p rust2go-common

sleep 10

cargo publish -p rust2go-convert

sleep 10

cargo publish -p rust2go-macro

sleep 10

cargo publish -p rust2go-mem-ffi

sleep 10

cargo publish -p mem-ring

sleep 10

cargo publish -p rust2go-cli

sleep 10

cargo publish -p rust2go

function wait_for_publish() {

local crate=$1

local attempts=0

local max_attempts=30

local delay=10

while [ $attempts -lt $max_attempts ]; do

if cargo search "$crate" --limit 1 | grep -q "$crate"; then

echo "$crate is published on crates.io"

return 0

fi

echo "Waiting for $crate to be published..."

sleep $delay

attempts=$((attempts + 1))

done

echo "Failed to verify publication of $crate after $((attempts * delay)) seconds"

exit 1

}

cargo publish -p rust2go-common

wait_for_publish rust2go-common

cargo publish -p rust2go-convert

wait_for_publish rust2go-convert

cargo publish -p rust2go-macro

wait_for_publish rust2go-macro

cargo publish -p rust2go-mem-ffi

wait_for_publish rust2go-mem-ffi

cargo publish -p mem-ring

wait_for_publish mem-ring

cargo publish -p rust2go-cli

wait_for_publish rust2go-cli

cargo publish -p rust2go

wait_for_publish rust2go

We prefer reducing defensive programming and letting errors fail fast.

Copilot · 2025-07-27T03:43:40Z

.github/workflows/release.yml

+    name: Publish to crates.io
+    runs-on: ubuntu-latest
+    needs: create-release
+    if: startsWith(github.ref, 'refs/tags/v') && !contains(github.ref, '-')


The condition for publishing to crates.io only checks for the absence of '-' in the tag, but this could incorrectly exclude valid stable versions that happen to contain a dash in the repository name or other parts of the ref. Consider using a more specific regex pattern to match prerelease versions (e.g., checking for patterns like '-alpha', '-beta', '-rc').

Suggested change

if: startsWith(github.ref, 'refs/tags/v') && !contains(github.ref, '-')

if: startsWith(github.ref, 'refs/tags/v') && !matches(github.ref, '.*-(alpha|beta|rc)\\d*$')

Reasonable.

lirenjie95 · 2025-07-31T01:59:55Z

.github/workflows/release.yml

+      - name: Setup Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: '1.22'


For compatibility, the go version here should be 1.18.

lirenjie95 · 2025-07-31T02:03:05Z

.github/workflows/release.yml

+        id: create_release
+        uses: softprops/action-gh-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}


GITHUB_TOKEN needs to be configured in repo Secrets. @ihciah

lirenjie95 · 2025-07-31T02:04:41Z

.github/workflows/release.yml

+
+      - name: Publish to crates.io
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}


CARGO_REGISTRY_TOKEN needs to be configured in repo Secrets. @ihciah

lirenjie95 · 2025-07-31T02:05:19Z

.github/workflows/release.yml

+    name: Publish to crates.io
+    runs-on: ubuntu-latest
+    needs: create-release
+    if: startsWith(github.ref, 'refs/tags/v') && !contains(github.ref, '-')


Reasonable.

.github/workflows/release.yml

scripts/update-version.sh

lirenjie95 marked this pull request as draft July 27, 2025 02:13

lirenjie95 requested a review from Copilot July 27, 2025 02:14

This comment was marked as outdated.

Sign in to view

lirenjie95 force-pushed the feat/releaseBot branch from 6119420 to a8fd545 Compare July 27, 2025 02:24

lirenjie95 requested a review from Copilot July 27, 2025 02:25

This comment was marked as outdated.

Sign in to view

lirenjie95 requested a review from Copilot July 27, 2025 02:30

This comment was marked as outdated.

Sign in to view

lirenjie95 force-pushed the feat/releaseBot branch from d6df2f7 to 02a490c Compare July 27, 2025 02:37

lirenjie95 requested a review from Copilot July 27, 2025 02:38

This comment was marked as outdated.

Sign in to view

feat: github release bot

e69d6a8

lirenjie95 force-pushed the feat/releaseBot branch from 02a490c to e69d6a8 Compare July 27, 2025 02:46

lirenjie95 marked this pull request as ready for review July 27, 2025 03:42

lirenjie95 requested review from Copilot, ihciah and suikammd July 27, 2025 03:42

lirenjie95 added the github_actions Pull requests that update GitHub Actions code label Jul 27, 2025

Copilot AI reviewed Jul 27, 2025

View reviewed changes

Bump version to 0.4.2

20b7d5b

lirenjie95 commented Jul 31, 2025

View reviewed changes

	if: startsWith(github.ref, 'refs/tags/v') && !contains(github.ref, '-')
	if: startsWith(github.ref, 'refs/tags/v') && !matches(github.ref, '.-(alpha\|beta\|rc)\\d$')

feat: github release bot #100

Are you sure you want to change the base?

feat: github release bot #100

Uh oh!

Conversation

lirenjie95 commented Jul 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automated Release Workflow:

Documentation Updates:

Version Management:

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Copilot AI Jul 27, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 27, 2025

Choose a reason for hiding this comment

Uh oh!

lirenjie95 Jul 27, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 27, 2025

Choose a reason for hiding this comment

Uh oh!

lirenjie95 Jul 31, 2025

Choose a reason for hiding this comment

Uh oh!

lirenjie95 Jul 31, 2025

Choose a reason for hiding this comment

Uh oh!

lirenjie95 Jul 31, 2025

Choose a reason for hiding this comment

Uh oh!

lirenjie95 Jul 31, 2025

Choose a reason for hiding this comment

Uh oh!

lirenjie95 Jul 31, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

lirenjie95 commented Jul 27, 2025 •

edited

Loading