-
-
Notifications
You must be signed in to change notification settings - Fork 970
docs: add Spring Security plugin upgrade instructions #15476
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: 7.0.x
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -865,3 +865,87 @@ grails: | |
| * **8.0**: `SimpleEnumMarshaller` will become the default | ||
|
|
||
| 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 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Was going off #15388, but we can move or close this.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think we just need to link to the doc. i am ok changing the rename script / rename.md since we discussed it
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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. |
||
|
|
||
| In Grails 7, the previously separate Spring Security plugin repositories have been consolidated into a single repository: https://github.com/apache/grails-spring-security[apache/grails-spring-security]. This repository now contains the core plugin and all extension plugins (ACL, CAS, LDAP, OAuth2, REST, and UI). | ||
|
|
||
| Along with the consolidation, the artifact coordinates have changed to follow the new Apache namespace. The most notable change is that `spring-security-core` has been renamed to `grails-spring-security` (dropping the `-core` suffix). | ||
|
|
||
| ====== Dependency Changes | ||
|
|
||
| Update your `build.gradle` dependencies as follows: | ||
|
|
||
| [cols="1,1",options="header"] | ||
| |=== | ||
| | Old Dependency | New Dependency | ||
|
|
||
| | `org.grails.plugins:spring-security-core` | ||
| | `org.apache.grails:grails-spring-security` | ||
|
|
||
| | `org.grails.plugins:spring-security-acl` | ||
| | `org.apache.grails:grails-spring-security-acl` | ||
|
|
||
| | `org.grails.plugins:spring-security-cas` | ||
| | `org.apache.grails:grails-spring-security-cas` | ||
|
|
||
| | `org.grails.plugins:spring-security-ldap` | ||
| | `org.apache.grails:grails-spring-security-ldap` | ||
|
|
||
| | `org.grails.plugins:spring-security-oauth2` | ||
| | `org.apache.grails:grails-spring-security-oauth2` | ||
|
|
||
| | `org.grails.plugins:spring-security-rest` | ||
| | `org.apache.grails:grails-spring-security-rest` | ||
|
|
||
| | `org.grails.plugins:spring-security-rest-gorm` | ||
| | `org.apache.grails:grails-spring-security-rest-datamapping` | ||
|
|
||
| | `org.grails.plugins:spring-security-rest-grailscache` | ||
| | `org.apache.grails:grails-spring-security-rest-grailscache` | ||
|
|
||
| | `org.grails.plugins:spring-security-rest-memcached` | ||
| | `org.apache.grails:grails-spring-security-rest-memcached` | ||
|
|
||
| | `org.grails.plugins:spring-security-rest-redis` | ||
| | `org.apache.grails:grails-spring-security-rest-redis` | ||
|
|
||
| | `org.grails.plugins:spring-security-ui` | ||
| | `org.apache.grails:grails-spring-security-ui` | ||
| |=== | ||
|
|
||
| ====== Example | ||
|
|
||
| A typical Spring Security Core dependency change: | ||
|
|
||
| [source,groovy] | ||
| .build.gradle | ||
| ---- | ||
| // Before (Grails 6) | ||
| implementation 'org.grails.plugins:spring-security-core:6.1.1' | ||
|
|
||
| // After (Grails 7) | ||
| implementation 'org.apache.grails:grails-spring-security' | ||
| ---- | ||
|
|
||
| NOTE: With the unified Grails BOM (see <<_4_unified_bill_of_materials>>), versions are managed automatically when using a Grails Gradle plugin. You no longer need to specify the version explicitly. | ||
|
|
||
| ====== REST Plugin Token Storage Submodules | ||
|
|
||
| If you use the Spring Security REST plugin with a specific token storage backend, note the following renames: | ||
|
|
||
| * `spring-security-rest-gorm` is now `grails-spring-security-rest-datamapping` (reflecting the rename of GORM to Grails Data Mapping) | ||
| * `spring-security-rest-grailscache` is now `grails-spring-security-rest-grailscache` | ||
|
|
||
| ====== Automated Migration | ||
|
|
||
| The coordinate rename script referenced in <<_5_coordinate_changes>> also handles Spring Security artifacts. Running it will update your Gradle files automatically: | ||
|
|
||
| [source,bash] | ||
| ---- | ||
| ./rename_gradle_artifacts.sh -l my/project/location | ||
| ---- | ||
|
|
||
| ====== Documentation | ||
|
|
||
| The Spring Security plugin documentation is available at https://apache.github.io/grails-spring-security/[apache.github.io/grails-spring-security]. | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why not fix the artifact id instead? I think this was a mistake