Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update README and CHANGELOG for 2.9.0 #236

Merged
merged 6 commits into from
Oct 18, 2024
Merged

chore: update README and CHANGELOG for 2.9.0 #236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c84ee2b
chore: reformat tables in README
satsukies Oct 8, 2024
789ce39
chore: added to support versions up to v8.7.x
satsukies Oct 8, 2024
c62cc98
chore: update CHANGELOG.md
satsukies Oct 8, 2024
df358ed
Update CHANGELOG.md
satsukies Oct 8, 2024
3e5d5ae
Update README.md
satsukies Oct 18, 2024
4a12179
Update README_JP.md
satsukies Oct 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# ChangeLog

## ver 2.9.0

- Support Android Gradle Plugin of below:
- 8.4.x (Jellyfish) with Gradle 8.6
- 8.5.x (Koala) with Gradle 8.7
- 8.6.x (Koala Feature Drop) with Gradle 8.7
- 8.7.x (Ladybug) with Gradle 8.9

## ver 2.8.0

- Support Android Gradle Plugin 8.3.0 (Iguana) with Gradle 8.4
Expand Down
66 changes: 35 additions & 31 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,35 +71,39 @@ This plugin does not work with non-app modules and/or library modules correctly.

## Version Compatibility

| Android Gradle Plugin | Gradle DeployGate Plugin |
|:----------------------|:-----------------------------|
| < 3.0.0 | 1.1.5 (No longer maintained) |
| 3.3.x, 3.4.x, 3.5.x | \>=2.0.0,\<2.6 |
| 3.6.x | \>=2.1.0,\<2.6 |
| 4.0.x | \>=2.2.0,\<2.6 |
| 4.1.x | \>=2.3.0,\<2.6 |
| 4.2.x | \>=2.4.0 |
| 7.0.x (Arctic Fox) | \>=2.4.0 |
| 7.1.x (Bumblebee) | \>=2.4.0 |
| 7.2.x (Chipmunk) | \>=2.4.0 |
| 7.3.x (Dolphin) | \>=2.4.0 |
| 7.4.x (Electric Eel) | \>=2.4.0 |
| 8.0.x (Flamingo) | \>=2.6.0 |
| 8.1.x (Giraffe) | \>=2.7.0 |
| 8.2.x (Hedgehog) | \>=2.7.0 |
| 8.3.x (Iguana) | \>=2.8.0 |
| Android Gradle Plugin | Gradle DeployGate Plugin |
|:---------------------------|:-----------------------------|
| < 3.0.0 | 1.1.5 (No longer maintained) |
| 3.3.x, 3.4.x, 3.5.x | \>=2.0.0,\<2.6 |
| 3.6.x | \>=2.1.0,\<2.6 |
| 4.0.x | \>=2.2.0,\<2.6 |
| 4.1.x | \>=2.3.0,\<2.6 |
| 4.2.x | \>=2.4.0 |
| 7.0.x (Arctic Fox) | \>=2.4.0 |
| 7.1.x (Bumblebee) | \>=2.4.0 |
| 7.2.x (Chipmunk) | \>=2.4.0 |
| 7.3.x (Dolphin) | \>=2.4.0 |
| 7.4.x (Electric Eel) | \>=2.4.0 |
| 8.0.x (Flamingo) | \>=2.6.0 |
| 8.1.x (Giraffe) | \>=2.7.0 |
| 8.2.x (Hedgehog) | \>=2.7.0 |
| 8.3.x (Iguana) | \>=2.8.0 |
| 8.4.x (Jellyfish) | \>=2.8.0 |
| 8.5.x (Koala) | \>=2.8.0 |
| 8.6.x (Koala Feature Drop) | \>=2.8.0 |
| 8.7.x (Ladybug) | \>=2.8.0 |

### Canary/Beta support table

We are not supporting Canary(Alpha) versions because of API stability. Please wait for beta releases or open an issue to support Canary versions.

> As of 2024 Mar 8th, Jellyfish is not tested yet.
> As of 2024 Oct 8th, Ladybug Feature Drop is not tested yet.

See the test matrix of [.github/workflows/build-and-test.yml](./.github/workflows/build-and-test.yml) for the latest information.

| JRE | Android Gradle Plugin | Gradle DeployGate Plugin |
|:----|:-------------------------|:-------------------------|
| 17 | - | - |
| JRE | Android Gradle Plugin | Gradle DeployGate Plugin |
|:----|:----------------------|:-------------------------|
| 17 | - | - |

### Binary compatibility

Expand Down Expand Up @@ -317,16 +321,16 @@ And also, please make sure your changes pass unit tests and acceptance tests. CI

We have deprecated some syntax and introduced the new syntax based on the table below.

Deprecated | New
:---|:----
*userName* | Use **appOwnerName**
*token* | Use **apiToken**
*apks* closure | Use **deployments** closure
*noAssemble* | Use **skipAssemble**
*distributionKey* | Use **key** in **distribution** closure
*releaseNote* | Use **releaseNote** in **distribution** closure
*DEPLOYGATE_USER_NAME* env | Use **DEPLOYGATE_APP_OWNER_NAME** instead
*DEPLOYGATE_RELEASE_NOTE* env | Use **DEPLOYGATE_DISTRIBUTION_RELEASE_NOTE** instead
| Deprecated | New |
|:------------------------------|:-----------------------------------------------------|
| *userName* | Use **appOwnerName** |
| *token* | Use **apiToken** |
| *apks* closure | Use **deployments** closure |
| *noAssemble* | Use **skipAssemble** |
| *distributionKey* | Use **key** in **distribution** closure |
| *releaseNote* | Use **releaseNote** in **distribution** closure |
| *DEPLOYGATE_USER_NAME* env | Use **DEPLOYGATE_APP_OWNER_NAME** instead |
| *DEPLOYGATE_RELEASE_NOTE* env | Use **DEPLOYGATE_DISTRIBUTION_RELEASE_NOTE** instead |

*If both of v1 and v2 variables are specified, v2 variables will be used.*

Expand Down
66 changes: 35 additions & 31 deletions README_JP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,35 +69,39 @@ DeployGate Gradle プラグインは非 app モジュールや android-library

## Version Compatibility

| Android Gradle Plugin | Gradle DeployGate Plugin |
|:----------------------|:-------------------------|
| < 3.0.0 | 1.1.5 (保守終了) |
| 3.3.x, 3.4.x, 3.5.x | \>=2.0.0,\<2.6 |
| 3.6.x | \>=2.1.0,\<2.6 |
| 4.0.x | \>=2.2.0,\<2.6 |
| 4.1.x | \>=2.3.0,\<2.6 |
| 4.2.x | \>=2.4.0 |
| 7.0.x (Arctic Fox) | \>=2.4.0 |
| 7.1.x (Bumblebee) | \>=2.4.0 |
| 7.2.x (Chipmunk) | \>=2.4.0 |
| 7.3.x (Dolphin) | \>=2.4.0 |
| 7.4.x (Electric Eel) | \>=2.4.0 |
| 8.0.x (Flamingo) | \>=2.6.0 |
| 8.1.x (Giraffe) | \>=2.7.0 |
| 8.2.x (Hedgehog) | \>=2.7.0 |
| 8.3.x (Iguana) | \>=2.8.0 |
| Android Gradle Plugin | Gradle DeployGate Plugin |
|:---------------------------|:-------------------------|
| < 3.0.0 | 1.1.5 (保守終了) |
| 3.3.x, 3.4.x, 3.5.x | \>=2.0.0,\<2.6 |
| 3.6.x | \>=2.1.0,\<2.6 |
| 4.0.x | \>=2.2.0,\<2.6 |
| 4.1.x | \>=2.3.0,\<2.6 |
| 4.2.x | \>=2.4.0 |
| 7.0.x (Arctic Fox) | \>=2.4.0 |
| 7.1.x (Bumblebee) | \>=2.4.0 |
| 7.2.x (Chipmunk) | \>=2.4.0 |
| 7.3.x (Dolphin) | \>=2.4.0 |
| 7.4.x (Electric Eel) | \>=2.4.0 |
| 8.0.x (Flamingo) | \>=2.6.0 |
| 8.1.x (Giraffe) | \>=2.7.0 |
| 8.2.x (Hedgehog) | \>=2.7.0 |
| 8.3.x (Iguana) | \>=2.8.0 |
| 8.4.x (Jellyfish) | \>=2.8.0 |
| 8.5.x (Koala) | \>=2.8.0 |
| 8.6.x (Koala Feature Drop) | \>=2.8.0 |
| 8.7.x (Ladybug) | \>=2.8.0 |

### Canary/Beta サポート情報

API仕様が頻繁に変わる可能性があることから、Canary(Alpha) バージョンのサポートは積極的に行っていません。Beta 版リリースをお待ちいただくか、Issue を起票してください。

> 2024/03/08現在、Jellyfish環境はまだテストをしていません。
> 2024/10/08現在、Ladybug Feature Drop環境はまだテストをしていません。

[.github/workflows/build-and-test.yml](./.github/workflows/build-and-test.yml) を参考にしてください

| JRE | Android Gradle Plugin | Gradle DeployGate Plugin |
|:----|:-------------------------|:-------------------------|
| 17 | - | - |
| JRE | Android Gradle Plugin | Gradle DeployGate Plugin |
|:----|:----------------------|:-------------------------|
| 17 | - | - |

### Binary compatibility

Expand Down Expand Up @@ -311,16 +315,16 @@ jitpack.io は初回のリクエストを受けてからスナップショット

いくつかの記述方法を非推奨とし、新しい記述方法を導入しています。変更点は次の表の通りです。

非推奨 | 新しく推奨される記述方法
:---|:----
*userName* | **appOwnerName**
*token* | **apiToken**
*apks* closure | **deployments** closure
*noAssemble* | **skipAssemble**
*distributionKey* | **distribution** closure の **key**
*releaseNote* | **distribution** closure の **releaseNote**
*DEPLOYGATE_USER_NAME* env | **DEPLOYGATE_APP_OWNER_NAME**
*DEPLOYGATE_RELEASE_NOTE* env | **DEPLOYGATE_DISTRIBUTION_RELEASE_NOTE**
| 非推奨 | 新しく推奨される記述方法 |
|:------------------------------|:-------------------------------------------|
| *userName* | **appOwnerName** |
| *token* | **apiToken** |
| *apks* closure | **deployments** closure |
| *noAssemble* | **skipAssemble** |
| *distributionKey* | **distribution** closure の **key** |
| *releaseNote* | **distribution** closure の **releaseNote** |
| *DEPLOYGATE_USER_NAME* env | **DEPLOYGATE_APP_OWNER_NAME** |
| *DEPLOYGATE_RELEASE_NOTE* env | **DEPLOYGATE_DISTRIBUTION_RELEASE_NOTE** |

*非推奨となった記述と新しい記述が混在する場合、新しい記述が基本的には優先されます。*

Expand Down
Loading