Skip to content

2024.1.0
Compare
Choose a tag to compare
@gabrielfeo gabrielfeo released this 06 Apr 21:12
· 120 commits to main since this release
2024.1.0
1605270
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.

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. The BuildsApi.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, exclude ch.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

Assets 2
Loading