From 3aba2bc9618f7847cba8741cb769b3aa7d8ad8ed Mon Sep 17 00:00:00 2001 From: Martin Bonnin Date: Thu, 14 Dec 2023 17:42:52 +0100 Subject: [PATCH 1/3] publish apollo-cli-incubating --- libraries/apollo-cli-incubating/build.gradle.kts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/libraries/apollo-cli-incubating/build.gradle.kts b/libraries/apollo-cli-incubating/build.gradle.kts index 4cd8178cd54..25e7b858f0d 100644 --- a/libraries/apollo-cli-incubating/build.gradle.kts +++ b/libraries/apollo-cli-incubating/build.gradle.kts @@ -5,8 +5,8 @@ plugins { apolloLibrary( javaModuleName = "com.apollographql.apollo3.cli", - publish = false ) + dependencies { implementation(project(":apollo-tooling")) implementation(project(":apollo-annotations")) From 819c5b85d50cbe42ae3a730051f09e467e9bce54 Mon Sep 17 00:00:00 2001 From: Martin Bonnin Date: Thu, 14 Dec 2023 17:56:38 +0100 Subject: [PATCH 2/3] more details on symbols lifecyle --- docs/source/index.md | 9 +++++++-- docs/source/migration/4.0.mdx | 2 +- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/source/index.md b/docs/source/index.md index e2c7962a5f5..9be38105eb4 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -218,9 +218,14 @@ And then use the `4.0.0-beta.5-SNAPSHOT` version for the plugin and libraries. Snapshots for the Android Studio / IntelliJ plugin [are also available](tree/main/intellij-plugin#snapshots). -## Deprecation policy +## Stability of different artifacts -The project observes [Semantic Versioning](https://semver.org/). No breaking change should be introduced in minor or patch releases. +Apollo Kotlin is very modular and publishes several artifacts. + +* Artifacts ending with `-incubating` are not finalized yet and subject to change any time. +* Other artifacts observe [Semantic Versioning](https://semver.org/). + * No breaking change should be introduced in minor or patch releases except for symbols annotated with `@ApolloExperimental` that are subject to change at any time. + * Deprecated symbols may be removed in the next major release. We strongly recommend removing deprecated usages before migrating to the next major version. ## Contributing diff --git a/docs/source/migration/4.0.mdx b/docs/source/migration/4.0.mdx index ebed2486790..00a868b3b89 100644 --- a/docs/source/migration/4.0.mdx +++ b/docs/source/migration/4.0.mdx @@ -9,7 +9,7 @@ Apollo Kotlin 3.0 was a major rewrite of Apollo in Kotlin multiplatform. Apollo Kotlin 4.0 focuses on tooling, stability and fixing some API regrets that came with 3.x. -Because most of the common APIs stayed the same, we [kept the package name unchanged](https://github.com/apollographql/apollo-kotlin/issues/4710). +Because most of the common APIs stayed the same, we [kept the package name unchanged](https://github.com/apollographql/apollo-kotlin/issues/4710). Apollo Kotlin 4.0 removes some deprecated symbols. We strongly recommend removing deprecated usages before migrating to 4.0. If you are using a lib that depends on Apollo Kotlin transitively, you need it to update to 4.x before you can update your own app to 4.0. From de356c410ab20fdfa8f472d1de5672ebc073bcc5 Mon Sep 17 00:00:00 2001 From: Martin Bonnin Date: Thu, 14 Dec 2023 18:02:27 +0100 Subject: [PATCH 3/3] keep README.md in sync --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 63ccfdbd52d..8254f521b63 100644 --- a/README.md +++ b/README.md @@ -234,9 +234,14 @@ And then use the `4.0.0-beta.5-SNAPSHOT` version for the plugin and libraries. Snapshots for the Android Studio / IntelliJ plugin [are also available](https://github.com/apollographql/apollo-kotlin/tree/main/intellij-plugin#snapshots). -## Deprecation policy +## Stability of different artifacts -The project observes [Semantic Versioning](https://semver.org/). No breaking change should be introduced in minor or patch releases. +Apollo Kotlin is very modular and publishes several artifacts. + +* Artifacts ending with `-incubating` are not finalized yet and subject to change any time. +* Other artifacts observe [Semantic Versioning](https://semver.org/). + * No breaking change should be introduced in minor or patch releases except for symbols annotated with `@ApolloExperimental` that are subject to change at any time. + * Deprecated symbols may be removed in the next major release. We strongly recommend removing deprecated usages before migrating to the next major version. ## Contributing