Skip to content

fix(example-shadow-api-detector): use official published plugin in examples - #96

Merged
Arc-E-Tect merged 2 commits into
mainfrom
fix/shadow-api-detector-examples-official-plugin
Aug 3, 2026
Merged

fix(example-shadow-api-detector): use official published plugin in examples#96
Arc-E-Tect merged 2 commits into
mainfrom
fix/shadow-api-detector-examples-official-plugin

Conversation

@Arc-E-Tect

Copy link
Copy Markdown
Owner

Summary

This PR updates the shadow-api-detector examples to consume the official published plugin release from the Gradle Plugin Portal instead of local source wiring.

What Changed

  • Removed local composite-build plugin wiring from:
    • examples/shadow-api-detector/openapi-3-2/settings.gradle
  • Standardized plugin versions to 0.4.0 in:
    • examples/shadow-api-detector/clean/gradle/libs.versions.toml
    • examples/shadow-api-detector/multi-file-openapi/gradle/libs.versions.toml
    • examples/shadow-api-detector/openapi-3-2/gradle/libs.versions.toml
    • examples/shadow-api-detector/with-shadow-apis/gradle/libs.versions.toml
  • Updated docs in:
    • examples/shadow-api-detector/openapi-3-2/README.adoc
    • Clarified that the example resolves the official published plugin release.

Why

  • Examples should mirror real consumer behavior by resolving published plugin artifacts.
  • Local includeBuild wiring can expose uncommitted local behavior and create confusion about what is actually released.
  • Keeping all related examples on the same released version improves consistency and comparability.

How

  • Removed includeBuild('../../../shadow-api-detector') from the OpenAPI 3.2 example settings.
  • Kept plugin resolution through gradlePluginPortal() and version-catalog pinned plugin version.
  • Advanced all relevant example version catalogs to 0.4.0.

Validation

  • Ran:
    • cd examples/shadow-api-detector/openapi-3-2
    • ./gradlew clean detectShadowApis
  • Result:
    • Build successful
    • Report generated at build/reports/shadow-api-detector/shadow-apis.adoc

Notes

…n to 0.4.0

What changed:\n- Updated examples/shadow-api-detector/with-shadow-apis/gradle/libs.versions.toml\n- Changed the shadow-api-detector version reference from 0.3.0 to 0.4.0\n\nWhy:\n- The example should consume the latest released plugin behavior used elsewhere in this update set\n- Keeping the example on 0.3.0 could hide newer report behavior and create inconsistent results between examples\n\nHow:\n- The version alias in the example's version catalog was advanced to 0.4.0\n- No task wiring or runtime semantics were changed beyond selecting the newer plugin artifact\n\nConstraints and caveats:\n- This commit intentionally updates only the with-shadow-apis example catalog to keep the change isolated\n\nOutcome:\n- The remaining dirty file is committed as its own logical unit, separate from the OpenAPI 3.2 disclaimer code changes.
…ss examples

What changed:\n- Removed local composite-build plugin wiring from examples/shadow-api-detector/openapi-3-2/settings.gradle\n- Updated shadow-api-detector plugin version to 0.4.0 in:\n  - examples/shadow-api-detector/clean/gradle/libs.versions.toml\n  - examples/shadow-api-detector/multi-file-openapi/gradle/libs.versions.toml\n  - examples/shadow-api-detector/openapi-3-2/gradle/libs.versions.toml\n- Updated examples/shadow-api-detector/openapi-3-2/README.adoc to document that it uses the official published plugin release\n\nWhy:\n- Examples should validate the public plugin as consumers use it, not local uncommitted source code\n- Local includeBuild wiring can mask publication-state differences and make behavior appear available before release\n\nHow:\n- Switched the OpenAPI 3.2 example from includeBuild-based plugin resolution to Gradle Plugin Portal resolution\n- Standardized shadow-api-detector example version catalogs on 0.4.0 for consistent behavior across examples\n\nSide effects and constraints:\n- Example behavior now reflects published plugin capabilities only\n- Future feature verification in examples requires released plugin versions unless local wiring is intentionally reintroduced\n\nOutcome:\n- OpenAPI 3.2 example continues to run successfully with ./gradlew clean detectShadowApis using published artifacts.
@Arc-E-Tect
Arc-E-Tect merged commit bca72d8 into main Aug 3, 2026
4 checks passed
@Arc-E-Tect
Arc-E-Tect deleted the fix/shadow-api-detector-examples-official-plugin branch August 3, 2026 17:40
Arc-E-Tect added a commit that referenced this pull request Aug 4, 2026
# [2.0.0](v1.6.0...v2.0.0) (2026-08-04)

### ✨ New and updated features

* **example-shadow-api-detector:** add composed RequestMapping example ([#98](#98)) ([6ea5163](6ea5163)), closes [#98](#98)
* **gherkin-to-asciidoc:** add indexing DSL property to number features and scenarios ([#99](#99)) ([5c207c4](5c207c4)), closes [#99](#99)
* **shadow-api-detector:** add OpenAPI 3.2 compatibility support and example ([#95](#95)) ([c57432b](c57432b)), closes [#95](#95)

### 🐛 Bug Fixes

* **gherkin-to-asciidoc:** set systemUnderTestVersion in snippet-templates example ([#94](#94)) ([ca7fb34](ca7fb34)), closes [#94](#94)
* **example-shadow-api-detector:** use official published plugin in examples ([#96](#96)) ([bca72d8](bca72d8)), closes [#96](#96)

### BREAKING CHANGE

* **gherkin-to-asciidoc:** includeSubDirs and groupByFeature now default to
true (previously false). A project relying on the old defaults -
particularly one using sourceFile without explicitly setting
includeSubDirs = false, which will now fail validation - must set
includeSubDirs = false and/or groupByFeature = false explicitly to
keep its previous behaviour. Feature file processing order is also
now deterministic (alphabetical by path, directory files before
sub-directory files) instead of filesystem-dependent, which may
reorder scenarios in existing generated reports.
@Arc-E-Tect

Copy link
Copy Markdown
Owner Author

🎉 This PR is included in version 2.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

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.

1 participant