Releases: gabrielfeo/develocity-api-kotlin
2024.2.0
Generated from the API spec of Develocity API 2024.2. Thanks to @clayburn for helping test this release.
What's Changed
New API spec
Notable changes
- Added: many new API endpoints and features (see API changelog)
- Removed: many previously deprecated endpoints and parameters (see API changelog)
- Removed: library's
LoggerFactory
is now internal (#294). Was never meant to be public. - Changed:
/api/builds
parameter order has changed in the Develocity API spec, andBuildsApi.getBuilds
has changed accordingly.⚠️ This is a breaking change if not using named arguments. - Changed: library's
DEVELOCITY_API_LOG_LEVEL
now has precedence over SLF4Jorg.slf4j.simpleLogger.defaultLogLevel
system property (#286)
Full Changelog from 2024.1.1: 2024.1.1...2024.2.0 (no library changes since last alpha: 2024.2.0-alpha03...2024.2.0)
2024.2.0-alpha03
Generated from the API spec of Develocity API 2024.2.
What's Changed (from 2024.1.1)
New API spec
Full Changelog: 2024.1.1...2024.2.0-alpha03
What's Changed (from 2024.2-alpha02)
Internal build changes only.
Full Changelog: 2024.2.0-alpha02...2024.2.0-alpha03
2024.2.0-alpha02
Generated from the API spec of Develocity API 2024.2.
What's Changed (from 2024.1.1)
New API spec
Full Changelog: 2024.1.1...2024.2.0-alpha02
What's Changed (from 2024.2-alpha01)
- Removed: Hide LoggerFactory from public API (#294)
- Changed: Fix
GradleConfigurationCacheResult.Outcome
enum naming (#288) - Changed:
DEVELOCITY_API_LOG_LEVEL
now has precedence over SLF4J ``org.slf4j.simpleLogger.defaultLogLevel` (#286)
Full Changelog: 2024.2.0-alpha01...2024.2.0-alpha02
2024.2.0-alpha01
Generated from the API spec of Develocity API 2024.2.
What's Changed
New API spec
- API changelog
- Generated API code diff: see
generated-api.patch
attached to this release
Full Changelog: 2024.1.1...2024.2.0-alpha01
2024.1.1
What's Changed
Library changes
This release fixes issues affecting 2024.1.0.
- Fixed: Kotlin scripts crash due to conflicting SLF4J bindings (#203)
- Fixed: Default log level was 'info' but should be 'off' (#203)
Full Changelog: 2024.1.0...2024.1.1
2024.1.0
Generated from the API spec of Develocity API 2024.1.
What's Changed
New API spec
- Bump Develocity API spec version to 2024.1 by @github-actions in #172
Library changes
This is a major release with breaking changes, but it's small steps to migrate (see below).
- 🚨 New (breaking change): as part of the product rename to Develocity, the library's artifact and all its classes are renamed to Develocity. This reflects the same change made by Gradle in the 2024.1 API spec.
- 🚨 Removed (breaking change): macOS Keychain support is removed in favor of environment variables. It was deprecated in 2023.4.0. See docs for a drop-in migration, if you'd like to keep your key in Keychain
- New: the 2024.1 API spec introduces support for requesting
allModels
in queries to/api/builds
. TheBuildsApi.getBuildsFlow
also supports this parameter - New:
AuthApi
, new in 2024.1, is now accessible from the library - New: Added SLF4J bindings to improve logging when settings
DEVELOCITY_API_LOG_LEVEL
. If you use the library in a project and it conflicts with your own, excludech.qos.logback:logback-classic
- Changed: bump Kotlin to 1.9.23
1. Rename the dependency to the new name
The old artifact will still work in this release, but consumers should already change it to the new name:
- Maven artifact:
com.gabrielfeo:gradle-enterprise-api-kotlin
->com.gabrielfeo:develocity-api-kotlin
- Kotlin Jupyter library:
%use gradle-enterprise-api-kotlin
->%use develocity-api-kotlin
(%useLatestDescriptors
might be needed to pull the latest libraries from Kotlin/kotlin-jupyter-libraries)
2. Rename your environment variables
All GRADLE_ENTERPRISE_
variables were renamed to DEVELOCITY_
. Take a look at your existing variables:
export | grep GRADLE_ENTERPRISE_ | less
And export the same variables under the new names. For example: GRADLE_ENTERPRISE_API_URL
-> DEVELOCITY_API_URL
.
3. Delete the old cache directory
The cache directory is also renamed. Only necessary if you enabled caching.
rm -rf "${GRADLE_ENTERPRISE_API_CACHE_DIR:-~/.gradle-enterprise-api-cache}"
4. Fix unresolved references
Some code might break, but it's as easy as renaming things to Develocity. For example: GradleEnterpriseApi.newInstance()
-> DevelocityApi.newInstance()
.
And you're done! 🥇
Full Changelog: 2023.4.0...2024.1.0
2023.4.0
Generated from the API spec of Gradle Enterprise API 2023.4.
What's Changed
New API spec
- Bump GE API spec version to 2023.4 by @github-actions in #132
Library changes
The 2023.4 API spec introduces support for getting /api/builds/{id}/gradle-attributes
(and others) embedded in the response of /api/builds
, via the new models
parameter. The getBuildsFlow
extension supports this. Using models
+ query
is recommended for a more efficient use of the API. getGradleAttributesFlow
is now deprecated in favor of getBuildsFlow(models = ...)
. Please refer to the latest README and examples. To help migrate existing code, the deprecation message has automatic migration on Intellij (Kotlin ReplaceWith
).
- Support 2023.4 models param by @gabrielfeo in #162 and #163
TestsApi
and the beta ProjectsApi
(2023.3) are now accessible from the library.
- Add missing APIs to GradleEnterpriseApi by @gabrielfeo in #174
macOS keychain support is deprecated in favor of environment variables (with your own solution to protect the access key, such as password manager integrations).
- Deprecate keychain support by @gabrielfeo in #164
This release uses Kotlin 1.9.22.
Full Changelog: 2023.3.1...2023.4.0
2023.4.0-alpha03
Generated from the API spec of Gradle Enterprise API 2023.4.
What's Changed
New API spec
Library changes
This release fixes an issue when using models
on the BuildsApi.getBuildsFlow
extension in which some of the requests would not send the models
param.
Full Changelog from last alpha: 2023.4.0-alpha02...2023.4.0-alpha03
Full Changelog from stable: 2023.3.1...2023.4.0-alpha03
Full Changelog: 2023.4.0-alpha02...2023.4.0-alpha03
2023.4.0-alpha02
Generated from the API spec of Gradle Enterprise API 2023.4.
What's Changed
New API spec
Library changes
This release adds support for requesting models
on the BuildsApi.getBuildsFlow
extension. models
was already supported in BuildsApi.getBuilds
(generated API).
Full Changelog from last alpha: 2023.4.0-alpha01...2023.4.0-alpha02
Full Changelog from stable: 2023.3.1...2023.4.0-alpha02
2023.4.0-alpha01
Generated from the API spec of Gradle Enterprise API 2023.4.
What's Changed
New API spec
Library changes
There were no library API changes (other than the generated API).
Full Changelog: 2023.3.1...2023.4.0-alpha01