Breaking Changes
Version 9.0.0+
Confluence was updated to 9.0.0
See the Atlassian Confluence 9.0.0 release notes for details.
Fragment changes
Please check out these pages to see what's changed with our Fragments:
- Raw XML Module Breaking Change for Confluence 9
- The formats for
condition class
andprovider class
has changed.
- The formats for
- Web Panel Breaking Change/Deprecation for Confluence 9.0.0
- The
writeHtml
method will now be ignored. - Atlassians
WebPanel
interface has moved to a new location.
- The
- Web Resource Breaking Change for Confluence 9.0.0
- All web resources should now be kept in
web-resources/com.onresolve.confluence.groovy.groovyrunner.
- All web resources should now be kept in
Third-party library/API removal
Atlassian has removed access to several third-party libraries. This means app vendors can no longer access these libraries from Confluence. We will now ship, as part of ScriptRunner, the third-party libraries that our plugin requires to function. However, if you have written scripts that use any of the APIs Atlassian has removed, you may find your scripts have broken. Your scripts will only break if they use APIs from removed dependencies that ScriptRunner does not include. You can review the list of removed APIs in the Atlassian documentation.
APIs removed
The following APIs have been removed for Confluence 9. If you use any of the removed APIs in your script, the scripts will break if they are not replaced. We have recommended replacements for you in the second column:
API removed | Recommened replacement |
---|---|
com.atlassian.confluence.plugins.index.api.mapping.FieldMapping.IndexFieldMappingConflictException | Removed |
| com.atlassian.confluence.impl.search.v2.DefaultContentPermissionCalculator#getEncodedPermissionsCollection(ContentPermissionSet contentPermissionSet) |
com.atlassian.confluence.search.v2.score.ScoreFunctionFactory#createContentTypeScoreFunction() | com.atlassian.confluence.search.v2.score.FunctionScoreQueryFactory.applyFunctionScoring(SearchQuery searchQuery) |
com.atlassian.confluence.search.v2.SearchFieldNames | com.atlassian.confluence.search.v2.SearchFieldMappings |
com.atlassian.confluence.search.v2.score.DecayParameters#getOrigin() | Changed to return string in Confluence 9 |
com.atlassian.confluence.search.v2.score.ScoreFunctionFactory#createRecencyOfModificationScoreFunction | com.atlassian.confluence.search.v2.score.FunctionScoreQueryFactory.applyFunctionScoring(SearchQuery searchQuery) |
com.atlassian.confluence.search.v2.score.StaircaseFunction | Not supported by OpenSearch |
com.atlassian.confluence.plugins.index.api.AnalyzerDescriptor | Not supported by OpenSearch |
| Removed |
| Removed |
Gadgets removed
The following gadgets have been removed for Confluence 9. If the gadgets are used in any of your scripts, scripts will break.
com.atlassian.gadgets.*
<gadget> module
Gadget macro
Streams gadget
Confluence page gadget
Confluence news gadget
Confluence search gadget
JDK Upgrade
The minimum supported version of the JDK is now JDK 17.
Version 8.0.0+
Groovy was updated to 4.0.7
See Groovy 4 Update section for details.
Deprecated SrSpecification class removed
Authors of script plugins may be used to writing tests which extend the deprecated com.onresolve.scriptrunner.canned.common.admin.SrSpecification
class. This class has been removed. Authors of tests for their scripts should extend the spock.lang.Specification
class directly. Tests should still be picked up by Test Runner built-in script as normal.
Version 7.0.0+
Custom Search Fields was updated in 7.7.0
The Search Extractors feature was removed and replaced with Custom Search Fields in ScriptRunner for Confluence release 7.7.0. Please refer to the Custom Search Fields documentation for more information.
Groovy was updated to 3.0.12
See the Groovy 3 Update section in the 7.0.0 Release Notes for details.
Spock was updated to 2.0
As part of upgrading to Groovy 3, we had to update Spock because there is no Groovy 3 compatible version of Spock 1.3, which was used in ScriptRunner 6.
You can use Spock to write and run unit tests within ScriptRunner. It is unlikely that tests written by ScriptRunner users would use parts of Spock 2.0 that contain breaking changes. However, if you maintain tests for your scripts, you should explore the breaking changes listed in the release notes for Spock 2.0.
JUnit 4 removal
Although it wasn't advertised in the documentation, it was possible to write and run unit tests using JUnit 4 in ScriptRunner 6. Spock 2.0 is based on JUnit Platform, not JUnit 4, so JUnit 4 tests will no longer work inside ScriptRunner.
If you wrote any tests using JUnit 4, you will need to rewrite them using Spock 2.0.
Version 6.17.0+
IE
The last ScriptRunner version compatible with IE11 is 6.17.0. Do not update ScriptRunner past this version if using IE11.