docs: add Spring Security plugin upgrade instructions#15476
docs: add Spring Security plugin upgrade instructions#15476jamesfredley wants to merge 2 commits into7.0.xfrom
Conversation
Document the consolidation of separate Spring Security plugin repositories into apache/grails-spring-security and the artifact coordinate changes, including the spring-security-core to grails-spring-security rename. Fixes #15388 Assisted-by: Claude Code <Claude@Claude.ai>
…cript Update rest-grailscache and rest-testapp-profile artifact names to match what grails-spring-security actually publishes: - grails-spring-security-grails-cache -> grails-spring-security-rest-grailscache - spring-security-rest-testapp -> spring-security-rest-testapp-profile Assisted-by: Claude Code <Claude@Claude.ai>
There was a problem hiding this comment.
Pull request overview
Adds explicit Grails 7 upgrade guidance for the consolidated Spring Security plugins and corrects Spring Security-related coordinate rename mappings to match the published artifacts.
Changes:
- Document Spring Security plugin repository consolidation and updated dependency coordinates in the upgrade guide (new section 12.27).
- Fix Spring Security REST “testapp profile” and “rest-grailscache” artifact rename mappings in the Gradle rename script.
- Correct the same two mappings in
RENAME.mdso it matches the actual published artifact IDs.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
grails-doc/src/en/guide/upgrading/upgrading60x.adoc |
Adds a new upgrade-guide section describing Spring Security plugin consolidation and updated Maven coordinates. |
etc/bin/rename_gradle_artifacts.sh |
Updates Spring Security mapping rules so automated renames target the correct published artifact IDs. |
RENAME.md |
Aligns the reference mapping table with the corrected Spring Security artifact IDs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | org.grails.plugins | spring-security-rest | org.apache.grails | grails-spring-security-rest | | | grails-spring-security | | ||
| | org.grails.plugins | spring-security-rest-gorm | org.apache.grails | grails-spring-security-rest-datamapping | | | grails-spring-security | | ||
| | org.grails.plugins | spring-security-rest-grailscache | org.apache.grails | grails-spring-security-grails-cache | | | grails-spring-security | | ||
| | org.grails.plugins | spring-security-rest-grailscache | org.apache.grails | grails-spring-security-rest-grailscache | | | grails-spring-security | |
There was a problem hiding this comment.
Why not fix the artifact id instead? I think this was a mistake
|
|
||
| The legacy `org.grails.web.converters.marshaller.json.EnumMarshaller` and `org.grails.web.converters.marshaller.xml.EnumMarshaller` classes are marked as `@Deprecated(forRemoval = true, since = "7.0.2")` and will be removed in Grails 8.0. | ||
|
|
||
| ===== 12.27 Spring Security Plugins |
There was a problem hiding this comment.
We have intentionally kept security docs separate. I am not sure we should be putting this detail here. Instead, why not link to the security docs?
There was a problem hiding this comment.
Was going off #15388, but we can move or close this.
There was a problem hiding this comment.
I think we just need to link to the doc. i am ok changing the rename script / rename.md since we discussed it
There was a problem hiding this comment.
I think we will need to create a good location on https://apache.github.io/grails-spring-security/. Consolidating those docs, might be part of the effort, so this might need to wait.
There was a problem hiding this comment.
I'm against putting all of this in the main grails-core docs, referencing it is completely and 100% acceptable. We are rapidly expanding docs and they will diverge since we may update in different orders. I'd rather we fix the spring security docs since that's where that info lives.
My main worry here is this information getting out of date and that causes more problems then not having them.
There was a problem hiding this comment.
Here's the necessary changes to create a single guide view of the spring security plugin: apache/grails-spring-security#1211
Summary
apache/grails-spring-securityrepositoryspring-security-corewas renamed tograils-spring-security(dropped the-coresuffix)rest-gorm->rest-datamapping,rest-grailscache->grails-cache)RENAME.mdandetc/bin/rename_gradle_artifacts.sh:grails-spring-security-grails-cache->grails-spring-security-rest-grailscache(verified against actualpublishArtifactId)spring-security-rest-testapp->spring-security-rest-testapp-profile(verified against actualpublishArtifactId)Fixes #15388