CHANGELOG for 0.2.0 (Keep a Changelog) and CONTRIBUTING

This commit is contained in:
CRTkafa 2026-10-10 02:16:06 +08:00
parent 4d6c285f2e
commit 25290c651a
2 changed files with 65 additions and 2 deletions

View file

@ -1,11 +1,44 @@
# Changelog # Changelog
## 0.1.0 (2026-10-09) All notable changes to this project are documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to
[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
- First release: Capacitor 8 plugin for Unity LevelPlay rewarded and interstitial ads (ad-unit API). ## [Unreleased]
## [0.2.0] - 2026-10-10
First public release on npm. No behaviour changes to the native bridges since 0.1.0.
### Added
- Complete README: compatibility table, iOS (SPM and CocoaPods) and Android setup, usage guide, mediation adapters
(Gradle, Swift packages, local-package workaround for networks without an official Swift package), privacy and
ATT guide, troubleshooting, FAQ.
- API reference generated from the JSDoc in `src/definitions.ts` with `@capacitor/docgen` (`bun run docgen`, also
part of `bun run build`); `dist/docs.json` ships with the package.
- JSDoc with `@since` for every method, option, event and type.
- `verify:android` script and a standalone Gradle setup (`android/settings.gradle`, Gradle wrapper 8.14.3) that builds
the Android library against `@capacitor/android` (dev dependency).
- `CONTRIBUTING.md`.
### Changed
- `package.json`: description, author (`VOX Games`, https://vox.games), `homepage`, `bugs`, `repository`, keywords,
`engines` (Node 22+, as Capacitor 8), `files` (adds `CHANGELOG.md`).
- Podspec: homepage from `package.json`, source is `https://git.crt.fyi/CRT/capacitor-levelplay.git` at tag
`v<version>`.
- `tsconfig.json`: no explicit `lib` (same defaults for `target: es2017`), so docgen resolves `Promise` types.
## [0.1.0] - 2026-10-09
### Added
- Capacitor 8 plugin for Unity LevelPlay rewarded and interstitial ads (ad-unit API).
- iOS: Swift Package Manager with the official LevelPlay-Swift-Package (SDK 9.6.1); podspec on `IronSourceSDK ~> 9.6.1`. - iOS: Swift Package Manager with the official LevelPlay-Swift-Package (SDK 9.6.1); podspec on `IronSourceSDK ~> 9.6.1`.
- Android: `com.unity3d.ads-mediation:mediation-sdk:9.6.1` from Maven Central, Play services ids, consumer ProGuard rules. - Android: `com.unity3d.ads-mediation:mediation-sdk:9.6.1` from Maven Central, Play services ids, consumer ProGuard rules.
- API: `initialize`, `setConsent` (GDPR / CCPA / COPPA), `setMetaData`, iOS ATT, load / show / isReady per ad unit, - API: `initialize`, `setConsent` (GDPR / CCPA / COPPA), `setMetaData`, iOS ATT, load / show / isReady per ad unit,
`launchTestSuite`, `validateIntegration`, events `loaded` `loadFailed` `displayed` `displayFailed` `clicked` `launchTestSuite`, `validateIntegration`, events `loaded` `loadFailed` `displayed` `displayFailed` `clicked`
`closed` `rewarded`. Show calls resolve after close with `{ shown, rewarded, reward?, error? }`. `closed` `rewarded`. Show calls resolve after close with `{ shown, rewarded, reward?, error? }`.
- `LEVELPLAY_DEMO`: Unity's public demo app keys and ad unit ids. - `LEVELPLAY_DEMO`: Unity's public demo app keys and ad unit ids.
[Unreleased]: https://git.crt.fyi/CRT/capacitor-levelplay/compare/v0.2.0...main
[0.2.0]: https://git.crt.fyi/CRT/capacitor-levelplay/compare/v0.1.0...v0.2.0
[0.1.0]: https://git.crt.fyi/CRT/capacitor-levelplay/releases/tag/v0.1.0

30
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,30 @@
# Contributing
Thanks for helping. Bug reports, questions and feature requests go to the
[issue tracker](https://git.crt.fyi/CRT/capacitor-levelplay/issues). For a bug, include the plugin version, the
LevelPlay SDK and adapter versions, the platform and OS version, and the native log (Xcode console or
`adb logcat | grep -E "LevelPlay|IronSource|IntegrationHelper"`).
## Development
Requirements: [Bun](https://bun.sh), Xcode 26+ for iOS, JDK 21 and the Android SDK for Android.
```sh
bun install
bun run build # docgen (README API section) + dist/
bun run typecheck
bun run verify:ios # xcodebuild the Swift package (iOS simulator)
JAVA_HOME=$(/usr/libexec/java_home -v 21) bun run verify:android
```
- The public API lives in `src/definitions.ts`. Document every method, option and event with JSDoc (`@since`), then
run `bun run build` so the API section of `README.md` is regenerated. Do not edit between the `docgen` markers by hand.
- Keep the Android (`android/src/main/java/...`) and iOS (`ios/Sources/...`) bridges in step: same method names, same
result and event shapes.
- `dist/` is committed so the package can be installed from git; rebuild it in the same commit as source changes.
- Add an entry under `Unreleased` in `CHANGELOG.md`.
## Pull requests
Keep them focused, describe what changed and how you tested it (device or simulator, OS version, network). By
contributing you agree that your work is released under the [MIT License](LICENSE).