Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add prepare release bash scripts #359

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

Jump to bottom
Merged
merged 1 commit into from
May 2, 2025
Merged

Add prepare release bash scripts #359

merged 1 commit into from
May 2, 2025

Conversation

@Frezyx
Copy link
Owner

@Frezyx Frezyx commented May 2, 2025 •
edited by sourcery-ai bot
Loading

Summary by Sourcery

Add bash scripts to automate release preparation and version management

New Features:

  • Create utility scripts for updating version, changelog, and preparing releases

Chores:

  • Implement bash scripts to streamline release process

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented May 2, 2025 •
edited
Loading

Reviewer's Guide

This pull request introduces three bash scripts (prepare_release.sh, update_version.sh, update_changelog.sh) and a configuration file (version.txt) located in the utils/ directory to automate the release preparation process, including version bumping in specific files and updating changelogs.

File-Level Changes

Change Details Files
Added a script to update version numbers in README.md and pubspec.yaml files.
  • Takes old and new version strings as arguments.
  • Uses find and sed to replace version strings in target files.
 utils/update_version.sh
Added a script to prepend new entries to all CHANGELOG.md files.
  • Takes version, description, and contributor name as arguments.
  • Formats the input into a changelog entry.
  • Uses find to locate changelogs and prepends the entry using temporary files.
 utils/update_changelog.sh
Added an orchestrator script and configuration file to manage the release preparation.
  • Added version.txt to store old version, new version, description, and contributor.
  • Added prepare_release.sh to read values from version.txt.
  • The script calls update_version.sh and update_changelog.sh with the read values.
 utils/prepare_release.sh
utils/version.txt
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@Frezyx Frezyx merged commit f83370a into master May 2, 2025
sourcery-ai[bot]
sourcery-ai bot reviewed May 2, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @Frezyx - I've reviewed your changes - here's some feedback:

  • Consider adding error checking after calling sub-scripts in prepare_release.sh to halt execution if a step fails.
  • The sed -i '' command in update_version.sh might not be portable across different operating systems (e.g., Linux vs. macOS).
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

utils/prepare_release.sh
Comment on lines +5 to +8
input_file="$SCRIPT_DIR/version.txt"

# Чтение строк
old_version=$(sed -n '1p' "$input_file" | xargs)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (bug_risk): Check that version.txt exists before processing.

This will produce a clearer error if version.txt is missing and make the script more robust.

Suggested change
input_file="$SCRIPT_DIR/version.txt"
# Чтение строк
old_version=$(sed -n '1p' "$input_file" | xargs)
input_file="$SCRIPT_DIR/version.txt"
# Check if version.txt exists before processing
if [[ ! -f "$input_file" ]]; then
echo "❌ $input_file does not exist."
exit 1
fi
# Чтение строк
old_version=$(sed -n '1p' "$input_file" | xargs)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Frezyx