Skip to content

Commit fa1d357

Browse files
committed
docs: update upgrade guide
Document the removal of redundant properties in generated `application.yml` files.
1 parent 3479842 commit fa1d357

1 file changed

Lines changed: 40 additions & 0 deletions

File tree

grails-doc/src/en/guide/upgrading/upgrading60x.adoc

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -869,3 +869,43 @@ The legacy `org.grails.web.converters.marshaller.json.EnumMarshaller` and `org.g
869869
==== 13. Upgrading the Spring Security Plugin
870870

871871
If your application uses the Grails Spring Security plugin, please consult the https://apache.github.io/grails-spring-security/snapshot/guide/index.html#upgrading-from-previous-versions[Upgrading from Previous Versions] section of the Spring Security plugin documentation for specific upgrade instructions related to Grails 7.
872+
873+
==== 14. Changes in CLI- and Forge-generated configuration files
874+
875+
From Grails 7.0.11 onwards, the CLIs (`grails-shell-cli` and `grails-forge-cli`) and the https://start.grails.org[Grails Forge website] no longer include several previously generated properties in `application.yml`.
876+
877+
Most of the removed entries simply restated framework defaults, so omitting them reduces clutter without changing behavior. However, `grails.urlmapping.cache.maxsize` is a special case: older generated applications explicitly set it to `1000`, while the framework default is now `5000`. If you want to preserve the older generated cache size, keep that property in your application.
878+
879+
If the application you are upgrading relies on a custom value for any of the following properties, or if you want to preserve the previous generated value of `grails.urlmapping.cache.maxsize`, keep that setting in your `application.yml` file.
880+
881+
These are the properties that were removed from generated `application.yml` files:
882+
883+
[source,yml]
884+
.application.yml
885+
----
886+
grails:
887+
controllers:
888+
defaultScope: singleton # already framework default
889+
converters:
890+
encoding: UTF-8 # already framework default
891+
mime:
892+
disable:
893+
accept:
894+
header:
895+
userAgents: # already framework default
896+
- Gecko
897+
- WebKit
898+
- Presto
899+
- Trident
900+
urlmapping:
901+
cache:
902+
maxsize: 1000 # Attention! framework default: 5000
903+
views:
904+
default:
905+
codec: html # redundant because GSP expressions already default to html encoding
906+
gsp:
907+
codecs:
908+
expression: html # already framework default
909+
taglib: none # already framework default
910+
staticparts: none # already framework default
911+
----

0 commit comments

Comments
 (0)