fix: get latest maintenance major tag from github releases #2076

sumwatshade · 2021-09-16T22:44:02Z

What Changed

This is a patch fix to tweak the way latest release is determined.

Why

When using versionBranches configuration, we observed that the calculated "latest release" relative to the maintenance branch was still the latest overall version, resulting in version conflicts. This change verifies that if versionBranches is enabled, then it will:

use the branch naming scheme to determine the major (ex. major-2 -> 2)
detect the latest git release within that major
calculate version bump based on that release.
Have current branch support the case that env-ci returns prBranch (undefined) and branch, which happens when merging to a branch that is non-default
suppress changelog rendering for maintenence case due to edge where commit hash is not being returned
Configure NPM to ignore the latest released version when in a maintenance release

Todo:

Add tests
Add docs (N/A, since this is a patch

Change Type

Indicate the type of change your pull request is:

documentation
patch
minor
major

🐤 Download canary assets:

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

📦 Published PR as canary version: under canary scope @auto-canary@10.32.2--canary.2076.24992.0

✨ Test out this PR locally via:

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

codecov · 2021-09-16T22:55:36Z

Codecov Report

Merging #2076 (0938c0e) into main (9f1a57d) will increase coverage by 0.00%.
The diff coverage is 74.07%.

@@           Coverage Diff           @@
##             main    #2076   +/-   ##
=======================================
  Coverage   80.19%   80.19%           
=======================================
  Files          66       66           
  Lines        5403     5414   +11     
  Branches     1254     1262    +8     
=======================================
+ Hits         4333     4342    +9     
  Misses        709      709           
- Partials      361      363    +2

Impacted Files	Coverage Δ
packages/core/src/auto.ts	`77.46% <50.00%> (-0.10%)`	⬇️
plugins/npm/src/index.ts	`72.20% <53.84%> (-0.67%)`	⬇️
packages/core/src/utils/get-current-branch.ts	`100.00% <100.00%> (+41.66%)`	⬆️
packages/core/src/utils/load-plugins.ts	`81.73% <100.00%> (ø)`

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 d79865f...0938c0e. Read the comment docs.

kelyvin · 2021-09-16T23:42:08Z

packages/core/src/auto.ts

    const isPrerelease = this.inPrereleaseBranch();
+
+    const maintenanceMajor = this.config?.versionBranches && typeof this.config?.versionBranches === "string" && currentBranch?.startsWith(this.config.versionBranches) ? 
+      parseInt(currentBranch.replace(this.config.versionBranches, ""), 10) : null
    const [, latestTagInBranch] = await on(this.git.getLatestTagInBranch());
    const lastRelease =
      from ||


From my understanding, this will prioritize the from value over the proper version number that you fetched with your function.

In the following line: https://github.com/intuit/auto/blob/main/packages/core/src/auto.ts#L1688, auto passes in the from: latestTag from the function getLatestTagInBranch(). getLatestTagInBranch can still return the incorrect tag version, and will get prioritized when passed into the getVersion method from the publishRelease function here: https://github.com/intuit/auto/blob/main/packages/core/src/auto.ts#L1714, then it will be prioritized over your change.

sumwatshade · 2021-10-21T00:59:39Z

Didn't mean to close it, seems like pushing a reset to origin triggers an auto-close of a PR :P I updated the logic to only include the fix.

packages/core/src/utils/get-current-branch.ts

sumwatshade · 2021-10-22T16:30:56Z

packages/core/src/utils/load-plugins.ts

@@ -166,18 +166,18 @@ export function findPlugin(
    return userPlugin;
  }

-  const officialPlugin = path.join("@auto-it", pluginPath);
+  const canaryPlugin = path.join("@auto-canary", pluginPath);


This prioritizes Canaries so I could test the NPM plugin 😄

sumwatshade · 2021-10-22T16:31:26Z

plugins/npm/src/index.ts

+  let isMaintenanceBranch = false;
+
+  if(auto.config?.versionBranches && currentBranch) {
+    isMaintenanceBranch = currentBranch.includes(typeof auto.config.versionBranches === "boolean" ? "version-" : auto.config.versionBranches)


Open to thoughts of how to source the default here

I think this check could go here as versionBranch instead (to align with the naming style for how preleaseBranch), then you could just pass versionBranch as an argument to getPreviousVersion directly.

spentacular · 2021-10-22T17:26:27Z

plugins/npm/src/index.ts

+  let isMaintenanceBranch = false;
+
+  if(auto.config?.versionBranches && currentBranch) {
+    isMaintenanceBranch = currentBranch.includes(typeof auto.config.versionBranches === "boolean" ? "version-" : auto.config.versionBranches)


I think this check could go here as versionBranch instead (to align with the naming style for how preleaseBranch), then you could just pass versionBranch as an argument to getPreviousVersion directly.

plugins/npm/src/index.ts

adierkens · 2021-10-26T18:32:48Z

🚀 PR was released in v10.32.2 🚀

adierkens added the patch Increment the patch version when merged label Sep 16, 2021

spentacular approved these changes Sep 16, 2021

View reviewed changes

kelyvin reviewed Sep 16, 2021

View reviewed changes

adierkens added the hacktoberfest label Oct 8, 2021

sumwatshade closed this Oct 21, 2021

sumwatshade force-pushed the fix/maintenance-branch-logic branch from 0465eeb to d79865f Compare October 21, 2021 00:53

fix: apply branch to getting latest tag

fb1c54e

sumwatshade reopened this Oct 21, 2021

lshadler added 2 commits October 20, 2021 21:58

fix: use env branch first

d4ade35

fix: use current branch calculator

4cffcdd

sumwatshade force-pushed the fix/maintenance-branch-logic branch from 4a86176 to 4cffcdd Compare October 21, 2021 03:09

lshadler added 3 commits October 21, 2021 09:36

fix: verbose logging on commit details

45a6b9b

fix: check what is passed to changelog render

47db891

fix: try loading canary plugin first

17f642f

sumwatshade force-pushed the fix/maintenance-branch-logic branch from e72fde5 to 17f642f Compare October 21, 2021 20:32

fix: check if maintenance version

e66ce5a

sumwatshade force-pushed the fix/maintenance-branch-logic branch from d14c773 to e66ce5a Compare October 22, 2021 00:49

sumwatshade commented Oct 22, 2021

View reviewed changes

packages/core/src/utils/get-current-branch.ts Outdated Show resolved Hide resolved

Update packages/core/src/utils/get-current-branch.ts

e0806f3

sumwatshade commented Oct 22, 2021

View reviewed changes

spentacular reviewed Oct 22, 2021

View reviewed changes

fix: pull logic to top apply level

f1c3f4a

spentacular approved these changes Oct 25, 2021

View reviewed changes

lshadler added 2 commits October 25, 2021 14:05

fix: testing around current branch logic

d0c97b7

test: add unit test for maintenance npm calc

0938c0e

spentacular approved these changes Oct 25, 2021

View reviewed changes

adierkens merged commit 1d1ba5c into intuit:main Oct 26, 2021

adierkens added the released This issue/pull request has been released. label Oct 26, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: get latest maintenance major tag from github releases #2076

fix: get latest maintenance major tag from github releases #2076

sumwatshade commented Sep 16, 2021 •

edited by adierkens

codecov bot commented Sep 16, 2021 •

edited

kelyvin Sep 16, 2021 •

edited

sumwatshade commented Oct 21, 2021 •

edited

sumwatshade Oct 22, 2021

sumwatshade Oct 22, 2021

spentacular Oct 22, 2021

spentacular Oct 22, 2021

adierkens commented Oct 26, 2021

fix: get latest maintenance major tag from github releases #2076

fix: get latest maintenance major tag from github releases #2076

Conversation

sumwatshade commented Sep 16, 2021 • edited by adierkens

What Changed

Why

Change Type

codecov bot commented Sep 16, 2021 • edited

Codecov Report

kelyvin Sep 16, 2021 • edited

Choose a reason for hiding this comment

sumwatshade commented Oct 21, 2021 • edited

sumwatshade Oct 22, 2021

Choose a reason for hiding this comment

sumwatshade Oct 22, 2021

Choose a reason for hiding this comment

spentacular Oct 22, 2021

Choose a reason for hiding this comment

spentacular Oct 22, 2021

Choose a reason for hiding this comment

adierkens commented Oct 26, 2021

sumwatshade commented Sep 16, 2021 •

edited by adierkens

codecov bot commented Sep 16, 2021 •

edited

kelyvin Sep 16, 2021 •

edited

sumwatshade commented Oct 21, 2021 •

edited