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

chore: Use the commitizen scm version provider #2892

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

Conversation

edgarrmondragon
Copy link
Collaborator

@edgarrmondragon edgarrmondragon commented Mar 1, 2025

Summary by Sourcery

Chores:

  • Configure commitizen to use the scm version provider.

📚 Documentation preview 📚: https://meltano-sdk--2892.org.readthedocs.build/en/2892/

Copy link
Contributor

sourcery-ai bot commented Mar 1, 2025

Reviewer's Guide by Sourcery

This pull request configures Commitizen to use the SCM version provider instead of a hardcoded version. This change allows Commitizen to automatically determine the current version from the SCM (e.g., Git) repository.

Class diagram for Commitizen configuration

classDiagram
  class CommitizenConfig {
    -name: str
    -version_provider: str
    -changelog_merge_prerelease: bool
    -prerelease_offset: int
    -tag_format: str
  }
  note for CommitizenConfig "Version provider changed from hardcoded version to SCM."
Loading

File-Level Changes

Change Details Files
Configured Commitizen to use the SCM version provider.
  • Replaced the hardcoded version with a version provider.
  • Configured the version provider to be SCM.
pyproject.toml

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

codecov bot commented Mar 1, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.33%. Comparing base (57a9bb4) to head (bf81274).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2892   +/-   ##
=======================================
  Coverage   91.33%   91.33%           
=======================================
  Files          62       62           
  Lines        5207     5207           
  Branches      675      675           
=======================================
  Hits         4756     4756           
  Misses        319      319           
  Partials      132      132           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

codspeed-hq bot commented Mar 1, 2025

CodSpeed Performance Report

Merging #2892 will not alter performance

Comparing edgarrmondragon/chore/commitizen-scm-provider (bf81274) with main (57a9bb4)

Summary

✅ 7 untouched benchmarks

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