Skip to content

Automate release process #243

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
Feb 19, 2025

Conversation

bessman
Copy link
Collaborator

@bessman bessman commented Feb 19, 2025

Summary by Sourcery

Automates the release process by creating draft releases and publishing to PyPI when a new tag is pushed.

CI:

  • Adds a workflow to automatically create a draft release when a new tag is pushed to the repository.
  • Adds a workflow to automatically publish the package to PyPI when a new release is published.

Copy link

sourcery-ai bot commented Feb 19, 2025

Reviewer's Guide by Sourcery

This pull request automates the release process by adding workflows to draft a release when a tag is pushed and publish the package to PyPI when a release is published. It also renames the lint workflow.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added a workflow to automatically draft a new release when a tag is pushed to the repository.
  • Configured the workflow to trigger on push events for tags matching the semantic versioning format.
  • Installed pcregrep to enable multi-line regex matching in the changelog.
  • Parsed the changelog to extract the changes associated with the current tag.
  • Used softprops/action-gh-release to create a draft release with the extracted changelog content as the body.
.github/workflows/release.yml
Added a workflow to automatically publish the package to PyPI when a release is published.
  • Configured the workflow to trigger on release published events.
  • Configured the job to run on Ubuntu.
  • Configured the job to use the pypi environment.
  • Granted the job permission to use the id-token.
  • Installed flit to build the package.
  • Built the package using flit build.
  • Published the package to PyPI using pypa/gh-action-pypi-publish.
.github/workflows/publish.yml
Renamed the lint workflow.
  • Renamed workflow.yml to lint.yml.
  • Updated the name of the workflow to lint.
.github/workflows/lint.yml
.github/workflows/workflow.yml

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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

Copy link

@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 @bessman - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider using a matrix strategy to run the same job with different Python versions.
  • Consider using a dedicated action for parsing the changelog instead of running pcregrep directly.
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.

@bessman bessman force-pushed the chore/release-automation branch from cd28c78 to cca56b3 Compare February 19, 2025 21:23
@bessman bessman merged commit 70b9ef1 into fossasia:development Feb 19, 2025
2 checks passed
@bessman bessman deleted the chore/release-automation branch February 19, 2025 21:24
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