Don't release canary on skip-release by default, add force flag

[zephraph]

Fixes #962

What Changed

Canaries now no longer publish for PRs that skip the release. A flag --force was added to the canary subcommand to make it always publish, regardless of label.

Why

Often times for things like docs updates or other trivial changes deploying a canary is extra noise that's unnecessary.

Open questions

1. Does shipit need to be updated with some sort of force flag?
2. Eslint complexity is over the limit on the canary function. Should I increase it or refactor that function to pull out some checks?
3. Did I miss updating things anywhere?
4. Should we invert this PR to make it where it releases by default but has a flag to skip canaries if skip release. (i.e. --respect-labels or something)

Todo:

• Figure out how to handle eslint complexity failure
• Add tests
• Add docs

📦 Published PR as canary version: under canary scope @auto-canary@9.15.4-canary.993.13171.0

✨ Test out this PR locally via:

npm install @auto-canary/auto@9.15.4-canary.993.13171.0
npm install @auto-canary/core@9.15.4-canary.993.13171.0
npm install @auto-canary/all-contributors@9.15.4-canary.993.13171.0
npm install @auto-canary/chrome@9.15.4-canary.993.13171.0
npm install @auto-canary/conventional-commits@9.15.4-canary.993.13171.0
npm install @auto-canary/crates@9.15.4-canary.993.13171.0
npm install @auto-canary/first-time-contributor@9.15.4-canary.993.13171.0
npm install @auto-canary/git-tag@9.15.4-canary.993.13171.0
npm install @auto-canary/gradle@9.15.4-canary.993.13171.0
npm install @auto-canary/jira@9.15.4-canary.993.13171.0
npm install @auto-canary/maven@9.15.4-canary.993.13171.0
npm install @auto-canary/npm@9.15.4-canary.993.13171.0
npm install @auto-canary/omit-commits@9.15.4-canary.993.13171.0
npm install @auto-canary/omit-release-notes@9.15.4-canary.993.13171.0
npm install @auto-canary/released@9.15.4-canary.993.13171.0
npm install @auto-canary/s3@9.15.4-canary.993.13171.0
npm install @auto-canary/slack@9.15.4-canary.993.13171.0
npm install @auto-canary/twitter@9.15.4-canary.993.13171.0
npm install @auto-canary/upload-assets@9.15.4-canary.993.13171.0
# or 
yarn add @auto-canary/auto@9.15.4-canary.993.13171.0
yarn add @auto-canary/core@9.15.4-canary.993.13171.0
yarn add @auto-canary/all-contributors@9.15.4-canary.993.13171.0
yarn add @auto-canary/chrome@9.15.4-canary.993.13171.0
yarn add @auto-canary/conventional-commits@9.15.4-canary.993.13171.0
yarn add @auto-canary/crates@9.15.4-canary.993.13171.0
yarn add @auto-canary/first-time-contributor@9.15.4-canary.993.13171.0
yarn add @auto-canary/git-tag@9.15.4-canary.993.13171.0
yarn add @auto-canary/gradle@9.15.4-canary.993.13171.0
yarn add @auto-canary/jira@9.15.4-canary.993.13171.0
yarn add @auto-canary/maven@9.15.4-canary.993.13171.0
yarn add @auto-canary/npm@9.15.4-canary.993.13171.0
yarn add @auto-canary/omit-commits@9.15.4-canary.993.13171.0
yarn add @auto-canary/omit-release-notes@9.15.4-canary.993.13171.0
yarn add @auto-canary/released@9.15.4-canary.993.13171.0
yarn add @auto-canary/s3@9.15.4-canary.993.13171.0
yarn add @auto-canary/slack@9.15.4-canary.993.13171.0
yarn add @auto-canary/twitter@9.15.4-canary.993.13171.0
yarn add @auto-canary/upload-assets@9.15.4-canary.993.13171.0

[hipstersmoothie]

Does shipit need to be updated with some sort of force flag?

I have added it as a configurable option. This is solved.

Eslint complexity is over the limit on the canary function. Should I increase it or refactor that function to pull out some checks?

I just turned it off. 🤷‍♂

Did I miss updating things anywhere?

To me it looks like your changes to packages/core/src/auto.ts is all that would be needed.

Should we invert this PR to make it where it releases by default but has a flag to skip canaries if skip release. (i.e. --respect-labels or something)

I feel like a new user would expect the release to be skipped also. I like this, it's a good sane default. This could be viewed as a major but it kind of seems like a bug that it was releasing anything at all.

Sometimes I use a skip-release label on a pr to batch two changes into one release. But I only ever do that at the end so it shouldn't be a problem.

[codecov]

Codecov Report

Merging #993 into master will increase coverage by 0.02%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master     #993      +/-   ##
==========================================
+ Coverage   80.91%   80.94%   +0.02%     
==========================================
  Files          44       44              
  Lines        3328     3332       +4     
  Branches      705      668      -37     
==========================================
+ Hits         2693     2697       +4     
  Misses        465      465              
  Partials      170      170

Impacted Files	Coverage Δ
packages/core/src/types.ts	100% <ø> (ø)	⬆️
packages/cli/src/parse-args.ts	96.66% <ø> (ø)	⬆️
packages/core/src/auto.ts	78.2% <100%> (+0.12%)	⬆️

---

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 11da64f...ba2510c. Read the comment docs.

[adierkens]

🚀 PR was released in v9.15.4 🚀

[zephraph]

Thanks for wrapping this up! Sorry I didn't get back to it.