Skip to content
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

Automate Release Process with New Versioning Script #602

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dylanpulver
Copy link
Collaborator

@dylanpulver dylanpulver commented Sep 12, 2024

This PR introduces a new script to automate our release process. The script streamlines version tagging, building, and publishing, significantly improving the efficiency of our release workflow. By automating these steps, we reduce manual errors, save time, and enhance our overall velocity. This improvement will allow the team to focus more on development and less on repetitive release tasks, ultimately accelerating our delivery of new features and fixes.

Summary by CodeRabbit

  • New Features

    • Introduced an automated release script that streamlines versioning, tagging, and publishing processes.
    • Ensures semantic versioning compliance and prompts user confirmation for critical steps.
    • Automates the cleanup of build artifacts and installation of necessary packages.
  • Bug Fixes

    • Improved validation checks for version input to prevent incorrect tagging.

Copy link

coderabbitai bot commented Sep 12, 2024

Walkthrough

The changes introduce a new release.sh script designed to automate the software release process. It validates the version number, pulls the latest changes from the Git repository, confirms the commit, creates a signed tag, and pushes it to GitHub. The script also handles cleanup of build artifacts, installs necessary packages, builds the package, and uploads it to PyPI, providing a link for verification.

Changes

File Change Summary
release.sh Added shebang, error handling, version validation, Git operations, cleanup, package installation, build, and upload commands.

Poem

🐇 In the meadow, a script takes flight,
Automating releases, oh what a sight!
With tags and pushes, it dances with glee,
A hop to PyPI, come celebrate with me!
Binaries attached, the process is bright,
A joyful release, all done just right! 🌼


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 15e757c and 1fc5c9e.

Files selected for processing (1)
  • release.sh (1 hunks)
Additional comments not posted (6)
release.sh (6)

1-4: LGTM!

The code changes are approved.


6-18: LGTM!

The code changes are approved.


20-33: LGTM!

The code changes are approved.


35-44: LGTM!

The code changes are approved.


50-60: LGTM!

The code changes are approved.


62-67: LGTM!

The code changes are approved.

Comment on lines +46 to +49
# Prompt user to create a release manually on GitHub
echo "Please create a release on GitHub from the tag here: https://github.com/pyupio/safety/releases/new"
echo "Attach the relevant binaries to the release before publishing."

Copy link

Choose a reason for hiding this comment

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

Consider automating the release creation.

The code changes are approved. However, consider automating the release creation step using the GitHub CLI to further streamline the process.

You can use the gh release create command to create a release from the pushed tag. For example:

# Create a release on GitHub from the tag
echo "Creating a release on GitHub..."
gh release create "$NEW_VERSION" --title "Release $NEW_VERSION" --notes "Release notes for version $NEW_VERSION"

This command creates a new release with the specified title and release notes. You can also attach binaries to the release using the --asset flag.

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