Skip to content

Latest commit

 

History

History
259 lines (215 loc) · 6.34 KB

RELEASING.md

File metadata and controls

259 lines (215 loc) · 6.34 KB
Raw

Releasing

Linux

  • Ensure java version is greater than or equal to 11
java --version
  • Set version variable in terminal shell
VERSION_NAME="<version name>"
  • Create a release branch
git checkout master
git pull
git checkout -b release_"$VERSION_NAME"

  • Update VERSION_NAME (remove -SNAPSHOT) and VERSION_CODE in root project's gradle.properties file

  • Update version in project's README.md documentation

  • Update CHANGELOG.md

  • Ensure that credentials for Npmjs are set in ~/.gradle/gradle.properties

    NPMJS_AUTH_TOKEN=<auth token>

  • Publish assets to Npmjs

PUBLISH_TASKS=$(./gradlew tasks -DKMP_TARGETS_ALL |
  grep "NpmPublicationToNpmjs" |
  cut -d ' ' -f 1
)
./gradlew $PUBLISH_TASKS --no-daemon --no-parallel -DKMP_TARGETS_ALL
  • Update .kotlin-js-store/yarn.lock
./gradlew kotlinUpgradeYarnLock -DKMP_TARGETS_ALL
  • Commit Changes
git add --all
git commit -S -m "Prepare $VERSION_NAME release"
git tag -s "$VERSION_NAME" -m "Release v$VERSION_NAME"
  • Make sure you have valid credentials in ~/.gradle/gradle.properties
mavenCentralUsername=MyUserName
mavenCentralPassword=MyPassword
  • Make sure you have GPG gradle config setup in ~/.gradle/gradle.properties for signing
signing.gnupg.executable=gpg
signing.gnupg.useLegacyGpg=true
signing.gnupg.homeDir=/path/to/.gnupg/
signing.gnupg.optionsFile=/path/to/.gnupg/gpg.conf
signing.gnupg.keyName=0x61471B8AB3890961
  • Make sure GPG is picking up YubiKey to sign releases
gpg --card-status
  • Disable YubiKey touch for signing
ykman openpgp keys set-touch sig off
  • Perform a clean build
./gradlew clean -DKMP_TARGETS_ALL
./gradlew build -PKMP_TARGETS="ANDROID,JVM,JS"
  • Publish
./gradlew publishAllPublicationsToMavenCentralRepository --no-daemon --no-parallel -PKMP_TARGETS="ANDROID,JVM,JS"
  • Re-enable YubiKey touch for signing
ykman openpgp keys set-touch sig on

  • The gradle-maven-publish-plugin should have automatically closed the staged repositories, but if it did not:

    • Close publications (Don't release yet)
      • Login to Sonatype OSS Nexus: oss.sonatype.org
      • Click on Staging Repositories
      • Select all Publications
      • Click Close then Confirm
      • Wait a bit, hit Refresh until the Status changes to Closed

  • Check Publication

./gradlew clean -PCHECK_PUBLICATION -DKMP_TARGETS_ALL
./gradlew :tools:check-publication:build --refresh-dependencies -PCHECK_PUBLICATION -DKMP_TARGETS_ALL

  • Release publications from Sonatype OSS Nexus StagingRepositories manager

    • Alternatively, can use Curl with the given repository id's that were output to terminal when publishing, e.g. iomatthewnelson-1018 
      curl -v -u "<USER NAME>" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  https://s01.oss.sonatype.org/service/local/staging/bulk/promote --data '
  {
    "data": {
      "stagedRepositoryIds": [
        "<repository id>",
        "<repository id>"
      ],
      "autoDropAfterRelease": true
    }
  }'

  • Merge release branch to master

git checkout master
git pull
git merge --no-ff -S release_"$VERSION_NAME"

  • Update VERSION_NAME (add -SNAPSHOT) and VERSION_CODE in root project's gradle.properties file

  • Commit changes

git add --all
git commit -S -m "Prepare for next development iteration"
  • Push Changes
git push
  • Push Tag
git push origin "$VERSION_NAME"
  • Delete local release branch
git branch -D release_"$VERSION_NAME"
  • Wait for releases to become available on MavenCentral
  • Draft new release on GitHub
    • Enter the release name as tag and title
    • Have the description point to the changelog