docs(gherkin-to-asciidoc): document the indexing property and default changes - #101
Merged
Merged
Conversation
…ludeSubDirs/groupByFeature default changes PR #99 shipped the indexing DSL property and flipped includeSubDirs/ groupByFeature to default to true, but never touched the plugin's own README - it still showed the old false defaults everywhere and had no mention of indexing at all. Updates the Groovy/Kotlin DSL samples, the configuration properties table, and the validation notes for the new defaults and the new property. Adds a "Numbering Features and Scenarios" section describing all four indexing values, the file processing/numbering order, and a before/after example, linking to the new indexing example. Updates "Sample Output"/"Grouping by Feature" to show the new default (grouped) output first, with groupByFeature = false now documented as the opt-out. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Arc-E-Tect
added a commit
that referenced
this pull request
Aug 5, 2026
# [2.1.0](v2.0.0...v2.1.0) (2026-08-05) ### ✨ New and updated features * **gherkin-to-asciidoc:** add ci indexing value and a CLI override for the whole build ([#102](#102)) ([063c069](063c069)), closes [#102](#102) [#99](#99) ### 📝 Documentation * **gherkin-to-asciidoc:** add multi-project example demonstrating the indexing modes ([#100](#100)) ([a0cd7a7](a0cd7a7)), closes [#100](#100) * **gherkin-to-asciidoc:** document the indexing property and the includeSubDirs/groupByFeature default changes ([#101](#101)) ([9fe4afd](9fe4afd)), closes [#101](#101) [#99](#99)
Owner
Author
|
🎉 This PR is included in version 2.1.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Arc-E-Tect
added a commit
that referenced
this pull request
Aug 10, 2026
# [1.0.0](shadow-api-detector-v0.4.0...shadow-api-detector-v1.0.0) (2026-08-10) ### ✨ New and updated features * **gherkin-to-asciidoc:** add ci indexing value and a CLI override for the whole build ([#102](#102)) ([063c069](063c069)), closes [#102](#102) [#99](#99) * **example-shadow-api-detector:** add composed RequestMapping example ([#98](#98)) ([6ea5163](6ea5163)), closes [#98](#98) * **gherkin-to-asciidoc:** add forceRewrite to skip renumbering already-numbered lines ([#103](#103)) ([48a74de](48a74de)), closes [#103](#103) * **gherkin-to-asciidoc:** add indexing DSL property to number features and scenarios ([#99](#99)) ([5c207c4](5c207c4)), closes [#99](#99) * **shadow-api-detector:** stop auto-wiring detectShadowApis into check ([#105](#105)) ([03a3da7](03a3da7)), closes [#105](#105) ### 🐛 Bug Fixes * **example-shadow-api-detector:** use official published plugin in examples ([#96](#96)) ([bca72d8](bca72d8)), closes [#96](#96) ### 📝 Documentation * **gherkin-to-asciidoc:** add multi-project example demonstrating the indexing modes ([#100](#100)) ([a0cd7a7](a0cd7a7)), closes [#100](#100) * **gherkin-to-asciidoc:** document the indexing property and the includeSubDirs/groupByFeature default changes ([#101](#101)) ([9fe4afd](9fe4afd)), closes [#101](#101) [#99](#99) ### BREAKING CHANGE * **shadow-api-detector:** detectShadowApis no longer runs automatically as part of check/build. Projects relying on the previous automatic wiring must add the dependsOn shown above to keep the check in their build. * **gherkin-to-asciidoc:** indexing's default numbering behaviour changes. Previously every generateFeatureDocs run fully renumbered every Feature/Scenario from scratch; by default it now preserves numbers that already match the current indexing value's format instead. Set forceRewrite = true (or -PgherkinToAsciidoc.forceRewrite=true) to keep the old always-renumber-everything behaviour. * **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.
Owner
Author
|
🎉 This PR is included in version 1.0.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
indexingDSL property and flippedincludeSubDirs/groupByFeatureto default totrue, but never updated the plugin's own README - it still showed the oldfalsedefaults everywhere and had no mention ofindexingat all.indexingvalues, the file processing/numbering order, and a before/after example, linking to the docs(gherkin-to-asciidoc): add multi-project example demonstrating the indexing modes #100 indexing example.groupByFeature = falsenow documented as the opt-out.