Skip to content

Update module github.com/prometheus/client_golang to v1.22.0 #30

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
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update module github.com/prometheus/client_golang to v1.22.0 #30

wants to merge 1 commit into from

Conversation

renovate-bot
Copy link
Contributor

@renovate-bot renovate-bot commented May 31, 2025 •
edited
Loading

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
github.com/prometheus/client_golang v1.19.1 -> v1.22.0 age adoption passing confidence

Release Notes

prometheus/client_golang (github.com/prometheus/client_golang)

v1.22.0: - 2025-04-07

Compare Source

⚠️ This release contains potential breaking change if you use experimental zstd support introduce in #​1496 ⚠️

Experimental support for zstd on scrape was added, controlled by the request Accept-Encoding header.
It was enabled by default since version 1.20, but now you need to add a blank import to enable it.
The decision to make it opt-in by default was originally made because the Go standard library was expected to have default zstd support added soon,
https://github.com/golang/go/issues/62513 however, the work took longer than anticipated and it will be postponed to upcoming major Go versions.

e.g.:

import (
  _ "github.com/prometheus/client_golang/prometheus/promhttp/zstd"
)
  • [FEATURE] prometheus: Add new CollectorFunc utility #​1724
  • [CHANGE] Minimum required Go version is now 1.22 (we also test client_golang against latest go version - 1.24) #​1738
  • [FEATURE] api: WithLookbackDelta and WithStats options have been added to API client. #​1743
  • [CHANGE] ⚠️ promhttp: Isolate zstd support and klauspost/compress library use to promhttp/zstd package. #​1765
All Changes

New Contributors

Full Changelog: prometheus/client_golang@v1.21.1...v1.22.0-rc.0

v1.21.1: / 2025-03-04

Compare Source

This release addresses a performance regression introduced in #​1661 -- thanks to all who reported this quickly:
@​chlunde, @​dethi, @​aaronbee @​tsuna @​kakkoyun 💪🏽. This patch release also fixes the iOS build.

We will be hardening the release process even further (#​1759, #​1761) to prevent this in future, sorry for the inconvenience!

The high concurrency optimization is planned to be eventually reintroduced, however in a much safer manner, potentially in a separate API.

  • [BUGFIX] prometheus: Revert of Inc, Add and Observe cumulative metric CAS optimizations (#​1661), causing regressions on low concurrency cases #​1757
  • [BUGFIX] prometheus: Fix GOOS=ios build, broken due to process_collector_* wrong build tags. #​1758
All commits

Full Changelog: prometheus/client_golang@v1.21.0...v1.21.1

v1.21.0: / 2025-02-19

Compare Source

⚠️ This release contains potential breaking change if you upgrade github.com/prometheus/common to 0.62+ together with client_golang (and depend on the strict, legacy validation for the label names). New common version changes model.NameValidationScheme global variable, which relaxes the validation of label names and metric name, allowing all UTF-8 characters. Typically, this should not break any user, unless your test or usage expects strict certain names to panic/fail on client_golang metric registration, gathering or scrape. In case of problems change model.NameValidationScheme to old model.LegacyValidation value in your project init function. ⚠️

  • [BUGFIX] gocollector: Fix help message for runtime/metric metrics. #​1583
  • [BUGFIX] prometheus: Fix Desc.String() method for no labels case. #​1687
  • [PERF] prometheus: Optimize popular prometheus.BuildFQName function; now up to 30% faster. #​1665
  • [PERF] prometheus: Optimize Inc, Add and Observe cumulative metrics; now up to 50% faster under high concurrent contention. #​1661
  • [CHANGE] Upgrade prometheus/common to 0.62.0 which changes model.NameValidationScheme global variable. #​1712
  • [CHANGE] Add support for Go 1.23. #​1602
  • [FEATURE] process_collector: Add support for Darwin systems. #​1600 #​1616 #​1625 #​1675 #​1715
  • [FEATURE] api: Add ability to invoke CloseIdleConnections on api.Client using api.Client.(CloseIdler).CloseIdleConnections() casting. #​1513
  • [FEATURE] promhttp: Add promhttp.HandlerOpts.EnableOpenMetricsTextCreatedSamples option to create OpenMetrics _created lines. Not recommended unless you want to use opt-in Created Timestamp feature. Community works on OpenMetrics 2.0 format that should make those lines obsolete (they increase cardinality significantly). #​1408
  • [FEATURE] prometheus: Add NewConstNativeHistogram function. #​1654
All commits * Merge release-1.20 to main by @​bwplotka in https://github.com/prometheus/client_golang/pull/1582 * gocollector: Tiny fix for help message with runtime/metrics source. by @​bwplotka in https://github.com/prometheus/client_golang/pull/1583 * ci: bump dagger to the latest version by @​marcosnils in https://github.com/prometheus/client_golang/pull/1588 * Merge release-1.20 back to main by @​ArthurSens in https://github.com/prometheus/client_golang/pull/1593 * Update linting by @​SuperQ in https://github.com/prometheus/client_golang/pull/1603 * Update supported Go versions by @​SuperQ in https://github.com/prometheus/client_golang/pull/1602 * build(deps): bump golang.org/x/sys from 0.22.0 to 0.24.0 by @​dependabot in https://github.com/prometheus/client_golang/pull/1611 * build(deps): bump github.com/prometheus/common from 0.55.0 to 0.57.0 by @​dependabot in https://github.com/prometheus/client_golang/pull/1612 * changed the name of all variables with min/max name by @​parthlaw in https://github.com/prometheus/client_golang/pull/1606 * Update Dagger and build. by @​SuperQ in https://github.com/prometheus/client_golang/pull/1610 * build(deps): bump github/codeql-action from 3.25.15 to 3.26.6 in the github-actions group across 1 directory by @​dependabot in https://github.com/prometheus/client_golang/pull/1614 * examples: Improved GoCollector example. by @​bwplotka in https://github.com/prometheus/client_golang/pull/1589 * Synchronize common files from prometheus/prometheus by @​prombot in https://github.com/prometheus/client_golang/pull/1615 * process_collector: fill in most statistics on macOS by @​mharbison72 in https://github.com/prometheus/client_golang/pull/1600 * ⚡ http client defer CloseIdleConnections by @​cuisongliu in https://github.com/prometheus/client_golang/pull/1513 * Set allow-utf-8 in Format during tests to avoid escaping. by @​ywwg in https://github.com/prometheus/client_golang/pull/1618 * Synchronize common files from prometheus/prometheus by @​prombot in https://github.com/prometheus/client_golang/pull/1622 * Merge Release 1.20 back to main by @​ArthurSens in https://github.com/prometheus/client_golang/pull/1627 * examples: Add custom labels example by @​ying-jeanne in https://github.com/prometheus/client_golang/pull/1626 * Refactor default runtime metrics tests for Go collector so that default runtime metric set autogenerates by @​vesari in https://github.com/prometheus/client_golang/pull/1631 * Synchronize common files from prometheus/prometheus by @​prombot in https://github.com/prometheus/client_golang/pull/1628 * process_xxx_memory statistics for macOS (cgo) by @​mharbison72 in https://github.com/prometheus/client_golang/pull/1616 * build(deps): bump github.com/klauspost/compress from 1.17.9 to 1.17.10 by @​dependabot in https://github.com/prometheus/client_golang/pull/1633 * build(deps): bump golang.org/x/sys from 0.24.0 to 0.25.0 by @​dependabot in https://github.com/prometheus/client_golang/pull/1632 * process_collector: Add Platform-Specific Describe for processCollector by @​ying-jeanne in https://github.com/prometheus/client_golang/pull/1625 * Synchronize common files from prometheus/prometheus by @​prombot in https://github.com/prometheus/client_golang/pull/1635 * build(deps): bump the github-actions group with 4 updates by @​dependabot in https://github.com/prometheus/client_golang/pull/1634 * Optionally print OM created lines by @​ArthurSens in https://github.com/prometheus/client_golang/pull/1408 * process_collector: merge wasip1 and js into a single implementation by @​ying-jeanne in https://github.com/prometheus/client_golang/pull/1644 * Merge release 1.20 to main by @​bwplotka in https://github.com/prometheus/client_golang/pull/1647 * Add Arianna as maintainer 💪 by @​ArthurSens in https://github.com/prometheus/client_golang/pull/1651 * test add headers round tripper by @​Manask322 in https://github.com/prometheus/client_golang/pull/1657 * build(deps): bump github.com/klauspost/compress from 1.17.10 to 1.17.11 by @​dependabot in https://github.com/prometheus/client_golang/pull/1668 * build(deps): bump golang.org/x/sys from 0.25.0 to 0.26.0 by @​dependabot in https://github.com/prometheus/client_golang/pull/1669 * build(deps): bump github.com/prometheus/common from 0.59.1 to 0.60.1 by @​dependabot in https://github.com/prometheus/client_golang/pull/1667 * build(deps): bump google.golang.org/protobuf from 1.34.2 to 1.35.1 by @​dependabot in https://github.com/prometheus/client_golang/pull/1670 * Optimize BuildFQName function by @​jkroepke in https://github.com/prometheus/client_golang/pull/1665 * fix: use injected now() instead of time.Now() in summary methods by @​imorph in https://github.com/prometheus/client_golang/pull/1672 * process_collector: avoid a compiler warning on macOS (fixes #​1660) by @​mharbison72 in https://github.com/prometheus/client_golang/pull/1675 * Synchronize common files from prometheus/prometheus by @​prombot in https://github.com/prometheus/client_golang/pull/1674 * build(deps): bump the github-actions group across 1 directory with 3 updates by @​dependabot in https://github.com/prometheus/client_golang/pull/1678 * [chore]: enable perfsprint linter by @​mmorel-35 in https://github.com/prometheus/client_golang/pull/1676 * Duplicate of #​1662 by @​imorph in https://github.com/prometheus/client_golang/pull/1673 * Synchronize common files from prometheus/prometheus by @​prombot in https://github.com/prometheus/client_golang/pull/1679 * chore: enable usestdlibvars linter by @​mmorel-35 in https://github.com/prometheus/client_golang/pull/1680 * Add: exponential backoff for CAS operations on floats by @​imorph in https://github.com/prometheus/client_golang/pull/1661 * Synchronize common files from prometheus/prometheus by @​prombot in https://github.com/prometheus/client_golang/pull/1683 * [1617] Add ConstnativeHistogram by @​shivanthzen in https://github.com/prometheus/client_golang/pull/1654 * fix: replace fmt.Errorf with errors.New by @​kakkoyun in https://github.com/prometheus/client_golang/pull/1689 * Add codeowners by @​kakkoyun in https://github.com/prometheus/client_golang/pull/1688 * fix: add very small delay between observations in `TestHistogramAtomicObserve` by @​imorph in https://github.com/prometheus/client_golang/pull/1691 * Synchronize common files from prometheus/prometheus by @​prombot in https://github.com/prometheus/client_golang/pull/1692 * Fix: handle nil variableLabels in Desc.String() method and add tests for nil label values by @​kakkoyun in https://github.com/prometheus/client_golang/pull/1687 * examples: Follow best practices and established naming conventions by @​lilic in https://github.com/prometheus/client_golang/pull/1650 * setup OSSF Scorecard workflow by @​mmorel-35 in https://github.com/prometheus/client_golang/pull/1432 * build(deps): bump google.golang.org/protobuf from 1.35.1 to 1.35.2 by @​dependabot in https://github.com/prometheus/client_golang/pull/1697 * build(deps): bump golang.org/x/sys from 0.26.0 to 0.27.0 by @​dependabot in https://github.com/prometheus/client_golang/pull/1696 * build(deps): bump the github-actions group with 5 updates by @​dependabot in https://github.com/prometheus/client_golang/pull/1695 * update links to openmetrics to reference the v1.0.0 release by @​dashpole in https://github.com/prometheus/client_golang/pull/1699 * build(deps): bump google.golang.org/protobuf from 1.35.2 to 1.36.1 by @​dependabot in https://github.com/prometheus/client_golang/pull/1706 * build(deps): bump golang.org/x/sys from 0.27.0 to 0.28.0 by @​dependabot in https://github.com/prometheus/client_golang/pull/1705 * build(deps): bump the github-actions group with 5 updates by @​dependabot in https://github.com/prometheus/client_golang/pull/1707 * build(deps): bump github.com/prometheus/common from 0.60.1 to 0.61.0 by @​dependabot in https://github.com/prometheus/client_golang/pull/1704 * Synchronize common files from prometheus/prometheus by @​prombot in https://github.com/prometheus/client_golang/pull/1703 * Synchronize common files from prometheus/prometheus by @​prombot in https://github.com/prometheus/client_golang/pull/1708 * Upgrade to prometheus/common 0.62.0 with breaking change by @​bwplotka in https://github.com/prometheus/client_golang/pull/1712 * build(deps): bump golang.org/x/net from 0.26.0 to 0.33.0 in /tutorials/whatsup by @​dependabot in https://github.com/prometheus/client_golang/pull/1713 * docs: Add RELEASE.md for the release process by @​kakkoyun in https://github.com/prometheus/client_golang/pull/1690 * tutorials/whatsup: Updated deps by @​bwplotka in https://github.com/prometheus/client_golang/pull/1716 * process collector: Fixed pedantic registry failures on darwin with cgo. by @​bwplotka in https://github.com/prometheus/client_golang/pull/1715 * Revert "ci: daggerize test and lint pipelines (#​1534)" by @​bwplotka in https://github.com/prometheus/client_golang/pull/1717 * Cut 1.21.0-rc.0 by @​bwplotka in https://github.com/prometheus/client_golang/pull/1718 * Cut 1.21 by @​bwplotka in https://github.com/prometheus/client_golang/pull/1737

New Contributors

Full Changelog: prometheus/client_golang@v1.20.5...v1.21.0

v1.20.5: / 2024-10-15

Compare Source

We decided to revert the testutil change that made our util functions less error-prone, but created a lot of work for our downstream users. Apologies for the pain! This revert should not cause any major breaking change, even if you already did the work--unless you depend on the exact error message.

Going forward, we plan to reinforce our release testing strategy [1],[2] and deliver an enhanced testutil package/module with more flexible and safer APIs.

Thanks to @​dashpole @​dgrisonnet @​kakkoyun @​ArthurSens @​vesari @​logicalhan @​krajorama @​bwplotka who helped in this patch release! 🤗

Changelog

[BUGFIX] testutil: Reverted #​1424; functions using compareMetricFamilies are (again) only failing if filtered metricNames are in the expected input. #​1645

v1.20.4

Compare Source

  • [BUGFIX] histograms: Fix a possible data race when appending exemplars vs metrics gather. #​1623

v1.20.3

Compare Source

  • [BUGFIX] histograms: Fix possible data race when appending exemplars. #​1608

v1.20.2

Compare Source

  • [BUGFIX] promhttp: Unset Content-Encoding header when data is uncompressed. #​1596

v1.20.1

Compare Source

This release contains the critical fix for the issue. Thanks to @​geberl, @​CubicrootXYZ, @​zetaab and @​timofurrer for helping us with the investigation!

  • [BUGFIX] process-collector: Fixed unregistered descriptor error when using process collector with PedanticRegistry on Linux machines. #​1587

v1.20.0

Compare Source

Thanks everyone for contributions!

⚠️ In this release we remove one (broken anyway, given Go runtime changes) metric and add three new (representing GOGC, GOMEMLIMIT and GOMAXPROCS flags) to the default collectors.NewGoCollector() collector. Given its popular usage, expect your binary to expose two additional metric.

Changes

  • [CHANGE] ⚠️ go-collector: Remove go_memstat_lookups_total metric which was always 0; Go runtime stopped sharing pointer lookup statistics. #​1577
  • [FEATURE] ⚠️ go-collector: Add 3 default metrics: go_gc_gogc_percent, go_gc_gomemlimit_bytes and go_sched_gomaxprocs_threads as those are recommended by the Go team. #​1559
  • [FEATURE] go-collector: Add more information to all metrics' HELP e.g. the exact runtime/metrics sourcing each metric (if relevant). #​1568 #​1578
  • [FEATURE] testutil: Add CollectAndFormat method. #​1503
  • [FEATURE] histograms: Add support for exemplars in native histograms. #​1471
  • [FEATURE] promhttp: Add experimental support for zstd on scrape, controlled by the request Accept-Encoding header. #​1496
  • [FEATURE] api/v1: Add WithLimit parameter to all API methods that supports it. #​1544
  • [FEATURE] prometheus: Add support for created timestamps in constant histograms and constant summaries. #​1537
  • [FEATURE] process-collectors: Add network usage metrics: process_network_receive_bytes_total and process_network_transmit_bytes_total. #​1555
  • [FEATURE] promlint: Add duplicated metric lint rule. #​1472
  • [BUGFIX] promlint: Relax metric type in name linter rule. #​1455
  • [BUGFIX] promhttp: Make sure server
    instrumentation wrapping supports new and future extra responseWriter methods. #​1480
  • [BUGFIX] testutil: Functions using compareMetricFamilies are now failing if filtered metricNames are not in the input. #​1424
All commits

New Contributors

Full Changelog: prometheus/client_golang@v1.19.1...v1.20.0

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@forking-renovate Forking Renovate
Copy link

ℹ Artifact update notice

File name: go.mod

In order to perform the update(s) described in the table above, Renovate ran the go get command, which resulted in the following additional change(s):

  • 8 additional dependencies were updated
  • The go directive was updated for compatibility reasons

Details:

Package Change
go 1.20 -> 1.22
github.com/cespare/xxhash/v2 v2.2.0 -> v2.3.0
github.com/klauspost/compress v1.12.3 -> v1.18.0
github.com/prometheus/client_model v0.5.0 -> v0.6.1
github.com/prometheus/common v0.48.0 -> v0.62.0
github.com/prometheus/procfs v0.12.0 -> v0.15.1
golang.org/x/net v0.20.0 -> v0.33.0
golang.org/x/sys v0.17.0 -> v0.30.0
google.golang.org/protobuf v1.33.0 -> v1.36.5

@gitstream-cm gitStream.cm
Copy link

gitstream-cm bot commented May 31, 2025

🚨 gitStream Monthly Automation Limit Reached 🚨

Your organization has exceeded the number of pull requests allowed for automation with gitStream.
Monthly PRs automated: 486/250

To continue automating your PR workflows and unlock additional features, please contact LinearB.

@sourcery-ai Sourcery AI
Copy link

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

Reviewer's Guide

This PR upgrades the project’s Go toolchain and module versions by bumping the Go directive to 1.22 (with toolchain go1.24.3), updating the Prometheus client library to v1.22.0, and refreshing associated indirect dependencies in go.mod for compatibility.

File-Level Changes

Change Details Files
Upgrade Go version and add toolchain directive
  • Bump go directive from 1.20 to 1.22
  • Add toolchain directive set to go1.24.3
 go.mod
Upgrade Prometheus client library to v1.22.0
  • Update github.com/prometheus/client_golang requirement from v1.19.1 to v1.22.0
 go.mod
Refresh indirect dependency versions
  • Bump versions of cespare/xxhash/v2, klauspost/compress, prometheus/client_model, common, procfs
  • Update golang.org/x/net, golang.org/x/sys, google.golang.org/protobuf and add munnerz/goautoneg
 go.mod
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

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented May 31, 2025 •
edited
Loading

Walkthrough

The Go module configuration was updated to use Go version 1.22 with a specified toolchain version 1.24.3. Several dependencies were upgraded to newer versions, and one new indirect dependency was added. No changes to exported or public entity declarations were made.

Changes

File Change Summary
go.mod Updated Go version and toolchain; upgraded multiple dependencies; added a new indirect dependency.

Poem

A hop and a skip, our Go mods renew,
With fresher dependencies, the code will pursue.
New toolchain in tow, and versions aligned,
The module now sparkles, robustly designed.
🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 137b06f and d2a6be7.

⛔ Files ignored due to path filters (1)
  • go.sum is excluded by !**/*.sum
📒 Files selected for processing (1)
  • go.mod (3 hunks)
🔇 Additional comments (8)
go.mod (8)

3-5: Update Go version and toolchain.
The bump to go 1.22 with toolchain go1.24.3 aligns with the Prometheus client’s new minimum requirement. Ensure your CI pipelines and local development environments are updated accordingly.

14-14: Upgrade Prometheus client_golang to v1.22.0.
This major update introduces new features (zstd support, CollectorFunc, WithStats, etc.) and potential breaking changes. Please run the full test suite and review the Prometheus client migration guide to catch any required code adjustments.

25-25: Promote xxhash to v2.3.0.
The /v2 module path implies your code must import github.com/cespare/xxhash/v2. Verify that all import statements have been updated to avoid version mismatches.

31-31: Update klauspost/compress to v1.18.0 (indirect).
The zstd support has been isolated into a separate package; since this is an indirect dependency, no direct code changes should be needed.

33-33: Add goautoneg as new indirect dependency.
This package is pulled in by the updated Prometheus client for HTTP content negotiation. No action is required unless you directly reference it.

37-39: Bump Prometheus common deps (client_model, common, procfs).
New versions include label/metric name validation changes and process‐collector enhancements. Validate your existing metrics, alerting rules, and scrape configurations for compatibility.

42-43: Upgrade x/net and x/sys to latest.
Routine module bumps; confirm that the codebase compiles cleanly and no unintended API changes affect networking or system calls.

45-45: Update protobuf runtime to v1.36.5.
Minor version bump for google.golang.org/protobuf; ensure any generated code or indirect consumers remain compatible.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@renovate-bot