Skip to content

Add docs for the codegen plugin#3288

Merged
skydoves merged 1 commit into
mainfrom
docs/codegen
Mar 30, 2026
Merged

Add docs for the codegen plugin#3288
skydoves merged 1 commit into
mainfrom
docs/codegen

Conversation

@skydoves

@skydoves skydoves commented Mar 30, 2026

Copy link
Copy Markdown
Member

Following up on this #3163 plugin work, this is a doc for the codegen plugin.


Note

Low Risk
Low risk: documentation-only change with no impact on runtime code or build logic.

Overview
Adds a new codegen/README.md that documents how to apply and configure the Purchases codegen Gradle plugin, including required credentials, caching/offline behavior, naming options, and security guidance.

Includes examples of the Kotlin code that gets generated (entitlement/offering/package IDs and extension properties), how to run rcFetchSchema/rcGenerateCode, troubleshooting tips, and trade-offs for dynamic dashboard changes.

Written by Cursor Bugbot for commit 7083e2a. This will update automatically on new commits. Configure here.

@skydoves skydoves self-assigned this Mar 30, 2026
@skydoves skydoves requested a review from a team as a code owner March 30, 2026 01:27
@codecov

codecov Bot commented Mar 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.38%. Comparing base (91558ee) to head (7083e2a).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3288   +/-   ##
=======================================
  Coverage   79.38%   79.38%           
=======================================
  Files         357      357           
  Lines       14349    14349           
  Branches     1960     1960           
=======================================
  Hits        11391    11391           
  Misses       2154     2154           
  Partials      804      804           

☔ 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.

@tonidero tonidero left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for adding this!

@skydoves skydoves added this pull request to the merge queue Mar 30, 2026
Merged via the queue into main with commit a485da9 Mar 30, 2026
35 checks passed
@skydoves skydoves deleted the docs/codegen branch March 30, 2026 23:30
github-merge-queue Bot pushed a commit that referenced this pull request Apr 2, 2026
**This is an automatic release.**

## RevenueCat SDK
### ✨ New Features
* Use Amazon deep link for Amazon subscription management (#3291) via
Cesar de la Vega (@vegaro)
* Introduce purchases codegen package (#3163) via Jaewoong Eum
(@skydoves)
### 🐞 Bugfixes
* Fix Test Store Purchase dialog not cancelling purchase on outside tap
(#3289) via Antonio Pallares (@ajpallares)

## RevenueCatUI SDK
### Paywallv2
#### 🐞 Bugfixes
* Fix mixed currencies in paywall price variables (PW-133) (#3119) via
Facundo Menzella (@facumenzella)

### 🔄 Other Changes
* Add docs for the codegen plugin (#3288) via Jaewoong Eum (@skydoves)
* Run integration tests against all backend environments (#3278) via
Toni Rico (@tonidero)
* Use merge queue for release PR merging (#3281) via Antonio Pallares
(@ajpallares)
* ci: warn when pre-built material-icons are imported in
:ui:revenuecatui (#3282) via Facundo Menzella (@facumenzella)

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Low Risk**
> Low risk: this is a version/release bookkeeping update plus docs/CI
deployment path changes, with no functional runtime logic changes beyond
the reported version string.
> 
> **Overview**
> Cuts the `9.29.0` release by switching all references from
`9.29.0-SNAPSHOT` to `9.29.0` (Gradle `VERSION_NAME`, internal
`frameworkVersion`, and sample/test app dependency versions).
> 
> Updates documentation publishing to point to the `9.29.0` docs
directory (CircleCI S3 sync path and `docs/index.html` redirect), and
rolls forward `CHANGELOG.md`/`CHANGELOG.latest.md` with the 9.29.0
release notes.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
bf217fd. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants