Skip to content

Conversation

@JP-Ellis
Copy link
Contributor

📝 Summary

Consumer version was recently added (in 3.2), and wasn't added to the docs properly.

🚨 Breaking Changes

🔥 Motivation

Improve visibility of the consumer_version method.

🔨 Test Plan

🔗 Related issues/PRs

@JP-Ellis JP-Ellis self-assigned this Nov 25, 2025
Copilot AI review requested due to automatic review settings November 25, 2025 03:28
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds documentation for the consumer_version method that was introduced in version 3.2 but not properly documented. The changes update the provider documentation and migration guide to demonstrate the new selector method.

Key changes:

  • Added comprehensive documentation for consumer_version method with usage examples
  • Updated code examples to replace deprecated consumer_tags with consumer_version
  • Removed deprecated tags parameter from publish options example

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
docs/provider.md Added new section documenting consumer_version method with common use cases and updated examples to use the new method instead of deprecated consumer_tags
MIGRATION.md Updated migration example to use consumer_version instead of consumer_tags and added explanation of the new method

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@codecov
Copy link

codecov bot commented Nov 25, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 51%. Comparing base (c612a67) to head (6c111af).
⚠️ Report is 2 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@         Coverage Diff          @@
##           main   #1364   +/-   ##
====================================
  Coverage    51%     51%           
====================================
  Files        31      31           
  Lines      3729    3729           
====================================
  Hits       1938    1938           
  Misses     1791    1791           
Flag Coverage Δ
tests 51% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

Consumer version was recently added (in 3.2).

Signed-off-by: JP-Ellis <josh@jpellis.me>
@JP-Ellis JP-Ellis force-pushed the docs/add-consumer-version branch from efe6206 to 6c111af Compare December 2, 2025 02:19
@JP-Ellis JP-Ellis enabled auto-merge (rebase) December 2, 2025 02:36
@JP-Ellis JP-Ellis merged commit dd62c72 into main Dec 2, 2025
89 of 91 checks passed
@JP-Ellis JP-Ellis deleted the docs/add-consumer-version branch December 2, 2025 02:39
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.

2 participants