add sbt plugin #1962

laughedelic · 2021-04-25T00:54:33Z

What Changed

Copy-pasted code from the git-tag, added relevant sbt commands (set version, publish, etc.), added canary hook.

Why

sbt is the de facto standard build tool for Scala projects.

I've tried to integrate with sbt through the exec plugin, it works perfectly for normal releases (only publish hook), but gets quite hairy for canaries:

  "plugins": [
    [
      "exec",
      {
        "publish": "sbt publish",
        "canary": "sbt --error --no-colors 'publish; set version/aggregate := false; print version' | tail -1"
      }
    ],
    "git-tag",
  ]

Mainly because canary combines publishing and versioning and requires new version as an output. And because sbt is not made for CLI scripts, so it's not easy to get the current version out of it.

So I took a stab at writing a proper plugin for sbt.

Todo:

I'm new to JavaScript/TypeScript, so take this with a grain of salt. If any code needs refactoring, I'll be grateful for pointers 🙏

Add docs
Add tests

I really have no idea how to test this 😥 especially with mocking and all. I've tested it manually on an actual project though.

Change Type

Indicate the type of change your pull request is:

documentation
patch
minor
major

🐤 Download canary assets:

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

📦 Published PR as canary version: under canary scope @[email protected]

✨ Test out this PR locally via:

npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
npm install @auto-canary/[email protected]
# or 
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]
yarn add @auto-canary/[email protected]

codecov · 2021-04-25T23:58:25Z

Codecov Report

❗ No coverage uploaded for pull request base (main@3c51664). Click here to learn what that means.
The diff coverage is 79.06%.

@@           Coverage Diff           @@
##             main    #1962   +/-   ##
=======================================
  Coverage        ?   80.26%           
=======================================
  Files           ?       66           
  Lines           ?     5380           
  Branches        ?     1249           
=======================================
  Hits            ?     4318           
  Misses          ?      705           
  Partials        ?      357

Impacted Files	Coverage Δ
plugins/sbt/src/index.ts	`79.06% <79.06%> (ø)`

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 3c51664...7ef81a8. Read the comment docs.

laughedelic · 2021-04-26T17:07:06Z

@hipstersmoothie hi! thanks for publishing a canary release. I just tried installing it on CI and running auto shipit and got this error:

Error [ERR_REQUIRE_ESM]: Must use import to load ES Module: /snapshot/auto/plugins/sbt/node_modules/strip-ansi/index.js
require() of ES modules is not supported.
require() of /snapshot/auto/plugins/sbt/node_modules/strip-ansi/index.js from /snapshot/auto/plugins/sbt/dist/index.js is an ES module file as it is a .js file whose nearest parent package.json contains "type": "module" which defines all .js files in that package scope as ES modules.
Instead rename /snapshot/auto/plugins/sbt/node_modules/strip-ansi/index.js to end in .cjs, change the requiring code to use import(), or remove "type": "module" from /snapshot/auto/plugins/sbt/node_modules/strip-ansi/package.json.

    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1152:13)
    at Module.load (internal/modules/cjs/loader.js:984:32)
    at Function.Module._load (internal/modules/cjs/loader.js:877:14)
    at Module.require (internal/modules/cjs/loader.js:1024:19)
    at Module.require (pkg/prelude/bootstrap.js:1225:31)
    at require (internal/modules/cjs/helpers.js:72:18)
    at Object.<anonymous> (/snapshot/auto/plugins/sbt/dist/index.js:7:46)
    at Module._compile (pkg/prelude/bootstrap.js:1320:22)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1156:10)
    at Module.load (internal/modules/cjs/loader.js:984:32) {
  code: 'ERR_REQUIRE_ESM'
}

in the config I refer to the plugin as just sbt.

hipstersmoothie · 2021-04-26T17:11:46Z

It looks like strip-ansi is now pure ESM. auto isn't set up to handle that yet so you'll have to use a 6.x version of strip-ansi

laughedelic · 2021-04-26T17:17:33Z

Ok, done in bef0fe9 👌

hipstersmoothie · 2021-04-26T18:39:28Z

kicked off another canary for you

laughedelic · 2021-04-26T18:57:01Z

Thanks! Just tried it out and it works as expected 🚀

plugins/sbt/src/index.ts

hipstersmoothie

This is looking good so far! Will def want to add some tests. Those tests will require lots of mocking of the exec function. You should be able to looks at other plugins and emulate their testing setup. Mainly just want to make sure the logic works and your options do something.

laughedelic · 2021-04-27T03:41:12Z

@hipstersmoothie I wrote some tests. I haven't quite wrapped my head around mocking with Jest yet, so it's not very smooth. But it's better than nothing and actually tests some functionality/configuration. I would appreciate any pointers on how to improve it.

hipstersmoothie

Tests look great! Looks mostly like other tests, nothing to suggest really. Jest mocks can be tricky though, I agree

hipstersmoothie · 2021-04-29T00:35:47Z

Wait 1 more thing:

Add a link to the sbt plugin here and here

laughedelic · 2021-04-29T00:42:54Z

@hipstersmoothie done: bd18523 👌

laughedelic · 2021-05-03T16:56:35Z

@hipstersmoothie could you give it another look?

adierkens · 2021-05-08T01:47:05Z

🚀 PR was released in v10.27.0 🚀

laughedelic added 3 commits April 22, 2021 02:00

generate sbt plugin

7fabc67

add code from git-tag, implement publish/canary hooks

3572002

add publish logs to the canary details

ca9252a

laughedelic changed the title ~~add sbt plugin~~ add sbt plugin (WIP) Apr 25, 2021

adierkens added the minor Increment the minor version when merged label Apr 25, 2021

laughedelic added 13 commits April 25, 2021 03:26

blank lines

136aa7b

add semver dependency

28fd6d6

refactor

437b4d3

add SNAPSHOT suffix to the canary version

1f55712

use strip-ansi

730b776

cut off v prefix

db009e1

clean output log

5e71703

unused import

baa64ec

add manageVersion config option

c820bfd

docs

7c6925e

linting

84ca44d

note about sbt version

5f91ad3

remove unused test

5f65920

laughedelic changed the title ~~add sbt plugin (WIP)~~ add sbt plugin Apr 25, 2021

laughedelic marked this pull request as ready for review April 25, 2021 23:58

laughedelic added 2 commits April 26, 2021 02:09

don't aggregate version

6b1ae33

trim version output

20bd60a

downgrade strip-ansi

bef0fe9

hipstersmoothie reviewed Apr 26, 2021

View reviewed changes

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

hipstersmoothie reviewed Apr 26, 2021

View reviewed changes

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

hipstersmoothie requested changes Apr 26, 2021

View reviewed changes

laughedelic added 9 commits April 27, 2021 02:11

add publishCommand option

d600aae

switch sbt-specific logs to verbose logger

8c2dda9

adjust sbtClient interface

f6cfefc

always set version on release

6de4587

rename manageVersion to setCanaryVersion

552297e

pull sbt helpers out for testing

266fdb6

first test for cleaning sbt client output

ec195d3

tests for sbtGetVersion

788db29

moar tests!

eba3fab

laughedelic requested a review from hipstersmoothie April 27, 2021 03:41

unused import

47627ce

hipstersmoothie approved these changes Apr 29, 2021

View reviewed changes

mention new plugin in the docs

bd18523

add link to sbt's readme

7ef81a8

hipstersmoothie merged commit df0218c into intuit:main May 8, 2021

adierkens added the released This issue/pull request has been released. label May 8, 2021

laughedelic deleted the feat/plugin/sbt branch May 9, 2021 13:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add sbt plugin #1962

add sbt plugin #1962

laughedelic commented Apr 25, 2021 •

edited

Loading

codecov bot commented Apr 25, 2021 •

edited

Loading

laughedelic commented Apr 26, 2021 •

edited

Loading

hipstersmoothie commented Apr 26, 2021

laughedelic commented Apr 26, 2021

hipstersmoothie commented Apr 26, 2021 •

edited

Loading

laughedelic commented Apr 26, 2021

hipstersmoothie left a comment

laughedelic commented Apr 27, 2021 •

edited

Loading

hipstersmoothie left a comment

hipstersmoothie commented Apr 29, 2021

laughedelic commented Apr 29, 2021

laughedelic commented May 3, 2021

adierkens commented May 8, 2021

add sbt plugin #1962

add sbt plugin #1962

Conversation

laughedelic commented Apr 25, 2021 • edited Loading

What Changed

Why

Todo:

Change Type

codecov bot commented Apr 25, 2021 • edited Loading

Codecov Report

laughedelic commented Apr 26, 2021 • edited Loading

hipstersmoothie commented Apr 26, 2021

laughedelic commented Apr 26, 2021

hipstersmoothie commented Apr 26, 2021 • edited Loading

laughedelic commented Apr 26, 2021

hipstersmoothie left a comment

Choose a reason for hiding this comment

laughedelic commented Apr 27, 2021 • edited Loading

hipstersmoothie left a comment

Choose a reason for hiding this comment

hipstersmoothie commented Apr 29, 2021

laughedelic commented Apr 29, 2021

laughedelic commented May 3, 2021

adierkens commented May 8, 2021

laughedelic commented Apr 25, 2021 •

edited

Loading

codecov bot commented Apr 25, 2021 •

edited

Loading

laughedelic commented Apr 26, 2021 •

edited

Loading

hipstersmoothie commented Apr 26, 2021 •

edited

Loading

laughedelic commented Apr 27, 2021 •

edited

Loading