docs: add configuration metadata reference#1210
Open
jamesfredley wants to merge 6 commits into7.0.xfrom
Open
Conversation
Add Spring configuration metadata for plugin properties and generate a configuration reference page in the docs build to surface these settings alongside the existing property tables. Assisted-by: OpenCode <opencode@opencode.ai> Assisted-by: Claude Code <Claude@Claude.ai>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds Spring Boot configuration metadata for the Spring Security Core plugin and wires docs generation to produce a configuration-properties reference page from that metadata, then includes it in the reference guide.
Changes:
- Add
META-INF/spring-configuration-metadata.jsondescribing Grails Spring Security Core configuration properties. - Add a Gradle task in
plugin-core/docsto generate an Asciidoctor page from the metadata during docs builds. - Include the generated configuration properties page in the docs index.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 9 comments.
| File | Description |
|---|---|
| plugin-core/plugin/src/main/resources/META-INF/spring-configuration-metadata.json | New Spring configuration metadata for IDE hints and as input to docs generation. |
| plugin-core/docs/build.gradle | Adds generateConfigurationProperties task and hooks it into asciidoctor. |
| plugin-core/docs/src/docs/index.adoc | Includes the new configuration properties page in the reference guide. |
| plugin-core/docs/src/docs/configurationProperties.adoc | New (generated) configuration properties reference page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
plugin-core/plugin/src/main/resources/META-INF/spring-configuration-metadata.json
Outdated
Show resolved
Hide resolved
plugin-core/plugin/src/main/resources/META-INF/spring-configuration-metadata.json
Outdated
Show resolved
Hide resolved
plugin-core/plugin/src/main/resources/META-INF/spring-configuration-metadata.json
Outdated
Show resolved
Hide resolved
plugin-core/plugin/src/main/resources/META-INF/spring-configuration-metadata.json
Outdated
Show resolved
Hide resolved
plugin-core/plugin/src/main/resources/META-INF/spring-configuration-metadata.json
Outdated
Show resolved
Hide resolved
plugin-core/plugin/src/main/resources/META-INF/spring-configuration-metadata.json
Outdated
Show resolved
Hide resolved
JSON files cannot contain comment-style Apache license headers. The metadata file follows the Spring Boot standard format. Assisted-by: Claude Code <Claude@Claude.ai>
RAT audit was flagging the generated AsciiDoc file for missing license header. Added standard Apache 2.0 license header using AsciiDoc comment block syntax. Assisted-by: Claude Code <Claude@Claude.ai>
…pty string handling - Replace '_none_' sentinel with actual defaults (null, [], or empty string) - Fix exceptionMappings type from Map to List to match plugin code - Fix grammar: 'a Authentication' to 'an Authentication', add missing comma - Change generated doc heading from = to == with === sub-sections for proper inclusion hierarchy in index.adoc - Add license header emission in generator - Handle empty string and empty list defaults distinctly from null in doc output Assisted-by: Claude Code <Claude@Claude.ai>
The file is regenerated by generateConfigurationProperties task every build. Committing it creates unnecessary diff noise. Assisted-by: Claude Code <Claude@Claude.ai>
Complete spring-configuration-metadata.json to cover all 145 properties defined in DefaultSecurityConfig.groovy. Add groups for remember-me, basic-digest-auth, switch-user, port-channel, and x509. Update orderedGroupNames in docs build.gradle to render all new sections. Assisted-by: Claude Code <Claude@Claude.ai>
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
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
Testing