Skip to content

chore: improve release process automation #18

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.

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
merged 1 commit into from
Jun 27, 2025

Conversation

fpelliccioni
Copy link
Contributor

Summary

This PR enhances the release process with better automation and consistency to reduce manual errors during releases.

Changes

  • release.sh:
    • Accept version as parameter instead of hardcoded value
    • Add automatic README version updates before creating release
    • Improve error handling and workflow consistency
  • update_readme_versions.sh: New script for version management
    • Cross-platform compatibility (macOS/Linux)
    • Validates version format
    • Updates all package README files consistently
    • Provides clear feedback on changes made

Benefits

  • Reduces manual errors: Automated version updates across documentation
  • Improves consistency: All package versions updated uniformly
  • Better UX: Clear usage instructions and error messages
  • Cross-platform: Works on both macOS and Linux development environments

Usage

# Before
./release.sh  # hardcoded version

# After  
./release.sh 0.68.0  # flexible version parameter

Testing

  • Tested version validation
  • Tested cross-platform sed compatibility
  • Verified README update patterns

- Make release.sh accept version as parameter instead of hardcoded value
- Add automatic README version updates before creating release
- Add new update_readme_versions.sh script for version management
  with cross-platform compatibility (macOS/Linux)
- Improve release.sh workflow to update documentation versions
  and commit them as part of the release process

This automation reduces manual errors and ensures consistency
across all package documentation during releases.
@fpelliccioni fpelliccioni merged commit 4b05614 into master Jun 27, 2025
13 checks passed
@fpelliccioni fpelliccioni deleted the chore/improve-release-process branch June 27, 2025 12:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant