Skip to content

patch: Omit pre-commit updates from CHANGELOG #299

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
May 27, 2025

Conversation

jmgate
Copy link
Collaborator

@jmgate jmgate commented May 27, 2025

Type: Task

Description

I thought 1aa9022 was sufficient for this, but apparently not. Trying again.

Related Issues/PRs

Follows #296.

Motivation

Just want a cleaner CHANGELOG.

Summary by Sourcery

Chores:

  • Adjust the exclude_commit_patterns regex in pyproject.toml to "ci.*pre-commit.*auto-update" instead of the fixed string

I thought 1aa9022 was sufficient for
this, but apparently not.  Trying again.
@jmgate jmgate self-assigned this May 27, 2025
Copy link

sourcery-ai bot commented May 27, 2025

Reviewer's Guide

Broaden the commit exclusion pattern in pyproject.toml to omit all pre-commit auto-update commits (including those prefixed with CI contexts) from the generated CHANGELOG.

Flow Diagram: Changelog Generation Process with Updated Commit Exclusion

graph TD
    A[Git Repository Commits] --> B{Changelog Generation Tool};
    C[pyproject.toml with 'exclude_commit_patterns'] -- Provides exclusion rules --> B;
    B -- Applies new pattern 'ci.*pre-commit.*auto-update' --> D[Filter Commits];
    D --> E[Generate CHANGELOG Text];
    E --> F[Output: Cleaner CHANGELOG];
Loading

File-Level Changes

Change Details Files
Refine exclusion pattern for pre-commit updates
  • Replaced literal "pre-commit auto-update" entry with regex
  • Added leading "ci.*" and trailing ".*auto-update" wildcards
  • Ensured any CI-prefixed pre-commit updates are now excluded
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!

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 May 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.97%. Comparing base (0240357) to head (b6298d8).
Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #299   +/-   ##
=======================================
  Coverage   93.97%   93.97%           
=======================================
  Files           2        2           
  Lines         166      166           
  Branches       37       37           
=======================================
  Hits          156      156           
  Misses          4        4           
  Partials        6        6           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@jmgate jmgate merged commit 335a3ce into master May 27, 2025
14 checks passed
@jmgate jmgate deleted the omit-pre-commit-updates-from-changelog branch May 27, 2025 15:45
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