diff --git a/CHANGELOG.md b/CHANGELOG.md index d45d2b4..da30a9f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,6 +14,12 @@ ### Security +## [0.9.0] - 2024-11-26 + +### Added + +- Provide an x86-64 based Java version when ARM64 is requested from macOS and none is available + ## [0.8.0] - 2024-01-12 ### Changed @@ -67,6 +73,7 @@ Toolchains resolver using the Foojay Disco API for resolving Java runtimes. Auto [Unreleased]: https://github.com/gradle/foojay-toolchains/compare/foojay-toolchains-plugin-0.8.0...HEAD +[0.9.0]: https://github.com/gradle/foojay-toolchains/releases/tag/foojay-toolchains-plugin-0.9.0 [0.8.0]: https://github.com/gradle/foojay-toolchains/releases/tag/foojay-toolchains-plugin-0.8.0 [0.7.0]: https://github.com/gradle/foojay-toolchains/releases/tag/foojay-toolchains-plugin-0.7.0 [0.6.0]: https://github.com/gradle/foojay-toolchains/releases/tag/foojay-toolchains-plugin-0.6.0 diff --git a/docs/plugin-release-process.md b/docs/plugin-release-process.md new file mode 100644 index 0000000..e1b413d --- /dev/null +++ b/docs/plugin-release-process.md @@ -0,0 +1,63 @@ +# Foojay Toolchains Plugin (FTP) Release Process + +## 1. Bump the plugin version number + +This should be the next version. +Verify that it's higher than the version reported [in the portal](https://plugins.gradle.org/plugin/org.gradle.toolchains.foojay-resolver). + +This lives in [`foojay-resolver/gradle.properties`](https://github.com/gradle/foojay-toolchains/blob/main/foojay-resolver/gradle.properties). + + +## 2. Add some release notes + +You'll need to add a plain text file with name [`foojay-resolver/release-notes-${plugin-version}.txt`](https://github.com/gradle/foojay-toolchains/tree/main/foojay-resolver). +Whatever you put here is what will appear in the portal for that version. +E.g. for [0.2](https://plugins.gradle.org/plugin/org.gradle.toolchains.foojay-resolver/0.2) it was "- Make the plugin compatible with Java 8". + +*NOTE:* Only include new changes relative to the previously published version. + +Remove any old release notes files. + + +## 3. Update the CHANGELOG.md file + +On one hand it needs some content describing what is in the new release, can be the same as the release notes above. +On the other hand it needs an entry towards the end of the file to specify which tag belongs to this new release. +See previous content for reference. + + +## 4. Deploy to Dev Portal + +Use [this job](https://builds.gradle.org/buildConfiguration/Dotcom_PluginsPortal_DeployFoojayToolchainsPluginDevelopment?branch=%3Cdefault%3E&buildTypeTab=overview&mode=builds#all-projects) to deploy the plugin to the dev portal. + +Make sure it [looks ok](https://plugins.grdev.net/plugin/org.gradle.toolchains.foojay-resolver) in the portal and the release notes are formatted as you want them to be. +Do the same check for the [convention version](https://plugins.grdev.net/plugin/org.gradle.toolchains.foojay-resolver-convention) too. + +If you need to make changes, you'll need to delete the published version from the portal before you try again. +Just use the big red "Delete version X" button of the [portal page](https://plugins.grdev.net/plugin/org.gradle.toolchains.foojay-resolver). +Don't forget about the [convention version](https://plugins.grdev.net/plugin/org.gradle.toolchains.foojay-resolver-convention) either. + + +## 5. Deploy to Prod Portal + +Use [this job](https://builds.gradle.org/buildConfiguration/Dotcom_PluginsPortal_DeployFoojayToolchainsPluginProduction?branch=%3Cdefault%3E&buildTypeTab=overview&mode=builds#all-projects) to deploy the plugin to the production portal. + +Make sure it [looks ok](https://plugins.gradle.org/plugin/org.gradle.toolchains.foojay-resolver) in the portal and the release notes are formatted as you want them to be. +Check the [convention version](https://plugins.gradle.org/plugin/org.gradle.toolchains.foojay-resolver-convention) too. + + +## 6. Tag the release + +We don't have any automated tagging, but please manually tag the current master and push it in, e.g.: + + git tag foojay-toolchains-plugin-1.0 + git push origin main --tags + + +## 7. Notify anyone waiting for a fix + + +## 8. Bump the development version of the plugin + +- Increment the version in [`foojay-resolver/gradle.properties`](https://github.com/gradle/foojay-toolchains/blob/main/foojay-resolver/gradle.properties). +- Update all usages of the previous version in [`the project`](https://github.com/gradle/foojay-toolchains/) diff --git a/foojay-resolver/release-notes-0.8.0.txt b/foojay-resolver/release-notes-0.8.0.txt deleted file mode 100644 index 1b06d8e..0000000 --- a/foojay-resolver/release-notes-0.8.0.txt +++ /dev/null @@ -1,2 +0,0 @@ -- Fix issues related to Java version parameter -- Bump Gson dependency version \ No newline at end of file diff --git a/foojay-resolver/release-notes-0.9.0.txt b/foojay-resolver/release-notes-0.9.0.txt new file mode 100644 index 0000000..abbaeda --- /dev/null +++ b/foojay-resolver/release-notes-0.9.0.txt @@ -0,0 +1 @@ +- Provide an x86-64 based Java version when ARM64 is requested from macOS and none is available \ No newline at end of file