[#523] Prepare for next release
This commit is contained in:
Carter Jernigan
Carter Jernigan
parent
cc29003afb
commit
18d82ed90c
|
|
@ -5,6 +5,7 @@ Version 1.5.0-beta01
|
|||
------------------------------------
|
||||
- New: Transactions can be created after NU5 activation.
|
||||
- New: Support for receiving v5 transactions.
|
||||
- Known issues: The SDK will not run on Intel 64-bit API 31+ emulators. Workarounds include: testing on a physical device, using an older 32-bit API version Intel emulator, or using an ARM emulator.
|
||||
|
||||
Version 1.4.0-beta01
|
||||
------------------------------------
|
||||
|
|
@ -14,6 +15,7 @@ Version 1.4.0-beta01
|
|||
- Internal bugfixes around concurrent access to resources, which could cause transient failures and data corruption
|
||||
- Added ProGuard rules so that SDK clients can use R8 to shrink their apps
|
||||
- Updated dependencies, including Kotlin 1.6.21, Coroutines 1.6.1, GRPC 1.46.0, Okio 3.1.0, NDK 23
|
||||
- Known issues: The SDK will not run on Intel 64-bit API 31+ emulators. Workarounds include: testing on a physical device, using an older 32-bit API version Intel emulator, or using an ARM emulator.
|
||||
|
||||
Version 1.3.0-beta20
|
||||
------------------------------------
|
||||
|
|
|
|||
|
|
@ -1,18 +1,63 @@
|
|||
# Publishing
|
||||
# Overview
|
||||
We aim for the main branch of the repository to always be in a releasable state.
|
||||
|
||||
Two types of artifacts can be published:
|
||||
1. Snapshot — An unstable release of the SDK for testing
|
||||
1. Release — A stable release of the SDK
|
||||
|
||||
Control of these modes of release is managed with a Gradle property `IS_SNAPSHOT`, which is
|
||||
Control of these modes of release is managed with a Gradle property `IS_SNAPSHOT`.
|
||||
|
||||
For both snapshot and release deployments, there are two ways to initiate deployment:
|
||||
1. Automatically — See [ci.md](ci.md), which describes the continuous integration workflow for deployment.
|
||||
2. Manually — See the remainder of this document for how to configure manual deployment.
|
||||
For both snapshot and release publishing, there are two ways to initiate deployment:
|
||||
1. Automatically
|
||||
2. Manually
|
||||
|
||||
Publishing requires:
|
||||
This document will focus initially on the automated process, with a section at the end on manual process. (The automated process more or less implements the manual process via GitHub Actions.)
|
||||
|
||||
### One time only
|
||||
# Automated Publishing
|
||||
## Snapshots
|
||||
All merges to the main branch trigger an automated [snapshot deployment](https://github.com/zcash/zcash-android-wallet-sdk/actions/workflows/deploy-snapshot.yml).
|
||||
|
||||
Note that snapshots do not have a stable API, so clients should not depend on a snapshot. The primary reason this is documented is for testing, e.g. before deploying a new production version of the SDK we may test against the snapshot first.
|
||||
|
||||
Snapshots can be consumed by:
|
||||
|
||||
1. Adding the snapshot repository
|
||||
settings.gradle.kts:
|
||||
```
|
||||
dependencyResolutionManagement {
|
||||
repositories {
|
||||
maven("https://oss.sonatype.org/content/repositories/snapshots") {
|
||||
// Optional; ensures only explicitly declared dependencies come from this repository
|
||||
content {
|
||||
includeGroup("cash.z.ecc.android")
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
2. Changing the dependency version to end with `-SNAPSHOT`
|
||||
|
||||
3. Rebuilding
|
||||
`./gradlew assemble --refresh-dependencies`
|
||||
|
||||
Because Gradle caches dependencies and because multiple snapshots can be deployed under the same version number, using `--refresh-dependencies` is important to ensure the latest snapshot is pulled. (#533 will make it easier to identify version of the snapshot in the future).
|
||||
|
||||
## Releases
|
||||
Production releases can be consumed using the instructions in the [README.MD](../README.md). Note that production releases can include alpha or beta designations.
|
||||
|
||||
Automated production releases still require a manual trigger. To do a production release:
|
||||
1. Update the CHANGELOG and MIGRATIONS.md for any new changes since the last production release.
|
||||
1. Run the [release deployment](https://github.com/zcash/zcash-android-wallet-sdk/actions/workflows/deploy-release.yml).
|
||||
1. Due to #535, release deployments are not fully automated. See the workaround steps in that issue and complete those steps.
|
||||
1. Confirm deployment succeeded by modifying the [ECC Wallet](https://github.com/zcash/zcash-android-wallet) to consume the new SDK version.
|
||||
1. Create a new Git tag for the new release in this repository.
|
||||
1. Create a new pull request bumping the version to the next version (this ensures that the next merge to the main branch creates a snapshot under the next version number).
|
||||
|
||||
# Manual Publishing
|
||||
See [ci.md](ci.md), which describes the continuous integration workflow for deployment and describes the secrets that would need to be configured in a repository fork.
|
||||
|
||||
## One time only
|
||||
* Set up environment to [compile the SDK](https://github.com/zcash/zcash-android-wallet-sdk/#compiling-sources)
|
||||
* Copy the GPG key to a directory with proper permissions (chmod 600). Note: If you'd like to quickly publish locally without subsequently publishing to Maven Central, configure a Gradle property `RELEASE_SIGNING_ENABLED=false`
|
||||
* Create file `~/.gradle/gradle.properties` per the [instructions in this guide](https://proandroiddev.com/publishing-a-maven-artifact-3-3-step-by-step-instructions-to-mavencentral-publishing-bd661081645d)
|
||||
|
|
@ -24,7 +69,7 @@ Publishing requires:
|
|||
* `signing.password`
|
||||
* `signing.secretKeyRingFile`
|
||||
|
||||
### Every time
|
||||
## Every time
|
||||
1. Update the [build number](https://github.com/zcash/zcash-android-wallet-sdk/blob/master/gradle.properties) and the [CHANGELOG](https://github.com/zcash/zcash-android-wallet-sdk/blob/master/CHANGELOG.md). For release builds, suffix the Gradle invocations below with `-PIS_SNAPSHOT=false`.
|
||||
3. Build locally
|
||||
* This will install the files in your local maven repo at `~/.m2/repository/cash/z/ecc/android/`
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ mavenCentralPassword=
|
|||
# Configures whether release is an unstable snapshot.
|
||||
IS_SNAPSHOT=true
|
||||
|
||||
LIBRARY_VERSION=1.5.0-beta01
|
||||
LIBRARY_VERSION=1.6.0-beta01
|
||||
POM_NAME=Zcash Android Wallet SDK
|
||||
GROUP=cash.z.ecc.android
|
||||
POM_ARTIFACT_ID=zcash-android-sdk
|
||||
|
|
|
|||
Loading…
Reference in New Issue