Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

simplify hook APIs for easier future extensibility #1609

Merged
merged 1 commit into from
Oct 27, 2020

Conversation

hipstersmoothie
Copy link
Collaborator

@hipstersmoothie hipstersmoothie commented Oct 26, 2020

Release Notes

This release simplifies some of the hooks arguements to allow for easier future extensibility.

The following hooks have had their second argument converted to an object that takes a "context" of pertinent information:

  • afterShipIt
  • onCreateChangelog
  • publish
  • next

Please consult the docs or plugin implementations for further detail.

Why

closes #1156

Todo:

  • Add tests
  • Add docs

Change Type

Indicate the type of change your pull request is:

  • documentation
  • patch
  • minor
  • major
📦 Published PR as canary version: under canary scope @auto-canary@9.60.2-canary.1609.19803.0

✨ Test out this PR locally via:

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

@hipstersmoothie hipstersmoothie added the major Increment the major version when merged label Oct 26, 2020
@codecov
Copy link

codecov bot commented Oct 27, 2020

Codecov Report

Merging #1609 into next will not change coverage.
The diff coverage is 77.77%.

Impacted file tree graph

@@           Coverage Diff           @@
##             next    #1609   +/-   ##
=======================================
  Coverage   80.36%   80.36%           
=======================================
  Files          60       60           
  Lines        4609     4609           
  Branches      996      996           
=======================================
  Hits         3704     3704           
  Misses        624      624           
  Partials      281      281           
Impacted Files Coverage Δ
packages/core/src/utils/make-hooks.ts 100.00% <ø> (ø)
packages/core/src/auto.ts 78.05% <60.00%> (ø)
plugins/docker/src/index.ts 82.97% <100.00%> (ø)
plugins/git-tag/src/index.ts 78.84% <100.00%> (ø)
plugins/npm/src/index.ts 73.92% <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 e2d4f11...593e973. Read the comment docs.

@hipstersmoothie hipstersmoothie merged commit f71a3b1 into next Oct 27, 2020
@hipstersmoothie hipstersmoothie deleted the hook-context branch October 27, 2020 16:38
@adierkens adierkens added the prerelease This change is available in a prerelease. label Oct 27, 2020
@adierkens adierkens mentioned this pull request Oct 27, 2020
@adierkens
Copy link
Collaborator

🚀 PR was released in v10.0.0 🚀

@adierkens adierkens added released This issue/pull request has been released. and removed prerelease This change is available in a prerelease. labels Oct 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
major Increment the major version when merged released This issue/pull request has been released.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants