Next/Canary Support for Gradle #1842

brocollie08 · 2021-03-02T01:41:47Z

What Changed

Tap into canary and next hooks in Gradle plugin to handle canary and prerelease

Why

Todo:

Add tests
Add docs

Change Type

Indicate the type of change your pull request is:

documentation
patch
minor
major

🐤 Download canary assets:

auto-linux-canary.1842.22803.gz
auto-macos-canary.1842.22803.gz
auto-win.exe-canary.1842.22803.gz

📦 Published PR as canary version: under canary scope @auto-canary@10.18.4-canary.1842.22803.0

✨ Test out this PR locally via:

npm install @auto-canary/bot-list@10.18.4-canary.1842.22803.0
npm install @auto-canary/auto@10.18.4-canary.1842.22803.0
npm install @auto-canary/core@10.18.4-canary.1842.22803.0
npm install @auto-canary/package-json-utils@10.18.4-canary.1842.22803.0
npm install @auto-canary/all-contributors@10.18.4-canary.1842.22803.0
npm install @auto-canary/brew@10.18.4-canary.1842.22803.0
npm install @auto-canary/chrome@10.18.4-canary.1842.22803.0
npm install @auto-canary/cocoapods@10.18.4-canary.1842.22803.0
npm install @auto-canary/conventional-commits@10.18.4-canary.1842.22803.0
npm install @auto-canary/crates@10.18.4-canary.1842.22803.0
npm install @auto-canary/docker@10.18.4-canary.1842.22803.0
npm install @auto-canary/exec@10.18.4-canary.1842.22803.0
npm install @auto-canary/first-time-contributor@10.18.4-canary.1842.22803.0
npm install @auto-canary/gem@10.18.4-canary.1842.22803.0
npm install @auto-canary/gh-pages@10.18.4-canary.1842.22803.0
npm install @auto-canary/git-tag@10.18.4-canary.1842.22803.0
npm install @auto-canary/gradle@10.18.4-canary.1842.22803.0
npm install @auto-canary/jira@10.18.4-canary.1842.22803.0
npm install @auto-canary/magic-zero@10.18.4-canary.1842.22803.0
npm install @auto-canary/maven@10.18.4-canary.1842.22803.0
npm install @auto-canary/microsoft-teams@10.18.4-canary.1842.22803.0
npm install @auto-canary/npm@10.18.4-canary.1842.22803.0
npm install @auto-canary/omit-commits@10.18.4-canary.1842.22803.0
npm install @auto-canary/omit-release-notes@10.18.4-canary.1842.22803.0
npm install @auto-canary/pr-body-labels@10.18.4-canary.1842.22803.0
npm install @auto-canary/released@10.18.4-canary.1842.22803.0
npm install @auto-canary/s3@10.18.4-canary.1842.22803.0
npm install @auto-canary/slack@10.18.4-canary.1842.22803.0
npm install @auto-canary/twitter@10.18.4-canary.1842.22803.0
npm install @auto-canary/upload-assets@10.18.4-canary.1842.22803.0
npm install @auto-canary/vscode@10.18.4-canary.1842.22803.0
# or 
yarn add @auto-canary/bot-list@10.18.4-canary.1842.22803.0
yarn add @auto-canary/auto@10.18.4-canary.1842.22803.0
yarn add @auto-canary/core@10.18.4-canary.1842.22803.0
yarn add @auto-canary/package-json-utils@10.18.4-canary.1842.22803.0
yarn add @auto-canary/all-contributors@10.18.4-canary.1842.22803.0
yarn add @auto-canary/brew@10.18.4-canary.1842.22803.0
yarn add @auto-canary/chrome@10.18.4-canary.1842.22803.0
yarn add @auto-canary/cocoapods@10.18.4-canary.1842.22803.0
yarn add @auto-canary/conventional-commits@10.18.4-canary.1842.22803.0
yarn add @auto-canary/crates@10.18.4-canary.1842.22803.0
yarn add @auto-canary/docker@10.18.4-canary.1842.22803.0
yarn add @auto-canary/exec@10.18.4-canary.1842.22803.0
yarn add @auto-canary/first-time-contributor@10.18.4-canary.1842.22803.0
yarn add @auto-canary/gem@10.18.4-canary.1842.22803.0
yarn add @auto-canary/gh-pages@10.18.4-canary.1842.22803.0
yarn add @auto-canary/git-tag@10.18.4-canary.1842.22803.0
yarn add @auto-canary/gradle@10.18.4-canary.1842.22803.0
yarn add @auto-canary/jira@10.18.4-canary.1842.22803.0
yarn add @auto-canary/magic-zero@10.18.4-canary.1842.22803.0
yarn add @auto-canary/maven@10.18.4-canary.1842.22803.0
yarn add @auto-canary/microsoft-teams@10.18.4-canary.1842.22803.0
yarn add @auto-canary/npm@10.18.4-canary.1842.22803.0
yarn add @auto-canary/omit-commits@10.18.4-canary.1842.22803.0
yarn add @auto-canary/omit-release-notes@10.18.4-canary.1842.22803.0
yarn add @auto-canary/pr-body-labels@10.18.4-canary.1842.22803.0
yarn add @auto-canary/released@10.18.4-canary.1842.22803.0
yarn add @auto-canary/s3@10.18.4-canary.1842.22803.0
yarn add @auto-canary/slack@10.18.4-canary.1842.22803.0
yarn add @auto-canary/twitter@10.18.4-canary.1842.22803.0
yarn add @auto-canary/upload-assets@10.18.4-canary.1842.22803.0
yarn add @auto-canary/vscode@10.18.4-canary.1842.22803.0

hipstersmoothie · 2021-03-02T02:22:55Z

plugins/gradle/src/index.ts

    auto.hooks.afterShipIt.tapPromise(this.name, async ({ dryRun }) => {
-      if (!this.snapshotRelease || dryRun) {
+      if (!this.snapshotRelease || dryRun || this.canaryRelease) {


This hook receives a context that will be canary if it's a canary release. you should be able to remove the class field and just do the check with context

hipstersmoothie · 2021-03-02T02:24:22Z

plugins/gradle/src/index.ts

@@ -238,8 +242,89 @@ export default class GradleReleasePluginPlugin implements IPlugin {
      ]);
    });

+    auto.hooks.canary.tapPromise(
+      this.name,
+      async ({ dryRun, quiet }) => {


This hook receives canaryIdentifier that should be used to create the canary version

plugins/gradle/src/index.ts

codecov · 2021-03-02T22:35:44Z

Codecov Report

Merging #1842 (ac38460) into main (e77a47c) will increase coverage by 0.02%.
The diff coverage is 77.77%.

@@            Coverage Diff             @@
##             main    #1842      +/-   ##
==========================================
+ Coverage   80.10%   80.12%   +0.02%     
==========================================
  Files          64       64              
  Lines        5001     5042      +41     
  Branches     1155     1171      +16     
==========================================
+ Hits         4006     4040      +34     
+ Misses        673      671       -2     
- Partials      322      331       +9

Impacted Files	Coverage Δ
plugins/gradle/src/index.ts	`74.78% <77.77%> (+4.27%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e77a47c...ac38460. Read the comment docs.

adierkens · 2021-03-18T21:03:14Z

🚀 PR was released in v10.20.6 🚀

sugarmanz · 2021-03-21T04:36:31Z

plugins/gradle/src/index.ts

@@ -103,6 +106,7 @@ export default class GradleReleasePluginPlugin implements IPlugin {
  private readonly updateGradleVersion = async (
    version: string,
    commitMsg?: string,
+    commit = true,


@sentony93 Adding a new param in the middle breaks existing callers. See line #356. This breaks the actual release since it no longer commits the prepared version. You should reorder the new argument to the end to ensure that you don't break existing call-sites.

slin8 added 3 commits March 1, 2021 17:28

[PLAYA-7576] - next and canary support for gradle plugin

af173e9

[PLAYA-7576] - remove comment

0fb17b2

[PLAYA-7576] - additional tests + skip afterShipIt for canary

60ab9fd

hipstersmoothie reviewed Mar 2, 2021

View reviewed changes

plugins/gradle/src/index.ts Show resolved Hide resolved

hipstersmoothie reviewed Mar 2, 2021

View reviewed changes

plugins/gradle/src/index.ts Outdated Show resolved Hide resolved

slin8 added 2 commits March 2, 2021 12:57

[PLAYA-7576] - addressed some PR comments

935c856

[PLAYA-7576] - determine next version

bcbc1c8

brocollie08 marked this pull request as ready for review March 2, 2021 22:15

hipstersmoothie closed this Mar 2, 2021

hipstersmoothie reopened this Mar 2, 2021

adierkens added the patch Increment the patch version when merged label Mar 2, 2021

[PLAYA-7576] - manage pre-release versions

7bd7fc6

brocollie08 closed this Mar 3, 2021

brocollie08 reopened this Mar 3, 2021

hipstersmoothie closed this Mar 3, 2021

hipstersmoothie reopened this Mar 3, 2021

slin8 added 5 commits March 3, 2021 17:32

[PLAYA-7576] - more specific logging

b53dd04

[PLAYA-7576] - do not commit version on next

a9573e4

[PLAYA-7576] - lint and tests

17bbf62

[PLAYA-7576] - coverage for dryRun

90835b1

[PLAYA-7576] - lint

ac38460

brocollie08 closed this Mar 11, 2021

brocollie08 reopened this Mar 11, 2021

hipstersmoothie approved these changes Mar 18, 2021

View reviewed changes

hipstersmoothie merged commit cbd4cf4 into intuit:main Mar 18, 2021

adierkens added the released This issue/pull request has been released. label Mar 18, 2021

sugarmanz reviewed Mar 21, 2021

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Next/Canary Support for Gradle #1842

Next/Canary Support for Gradle #1842

brocollie08 commented Mar 2, 2021 •

edited

hipstersmoothie Mar 2, 2021

hipstersmoothie Mar 2, 2021

codecov bot commented Mar 2, 2021 •

edited

adierkens commented Mar 18, 2021

sugarmanz Mar 21, 2021

Next/Canary Support for Gradle #1842

Next/Canary Support for Gradle #1842

Conversation

brocollie08 commented Mar 2, 2021 • edited

What Changed

Why

Change Type

hipstersmoothie Mar 2, 2021

Choose a reason for hiding this comment

hipstersmoothie Mar 2, 2021

Choose a reason for hiding this comment

codecov bot commented Mar 2, 2021 • edited

Codecov Report

adierkens commented Mar 18, 2021

sugarmanz Mar 21, 2021

Choose a reason for hiding this comment

brocollie08 commented Mar 2, 2021 •

edited

codecov bot commented Mar 2, 2021 •

edited