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.

Sign up for GitHub

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

Jump to bottom

Update docs for "afterAddToChangelog" → "afterChangelog" rename #1951

Merged
merged 1 commit into from Apr 17, 2021
Merged

Update docs for "afterAddToChangelog" → "afterChangelog" rename #1951

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/pages/docs/plugins/release-lifecycle-hooks.mdx
View file
Open in desktop
Expand Up @@ -71,7 +71,7 @@ _Other examples:_
- In Core: Create major version branches when `major` happens
- [npm](../generated/npm) - Create sub-package changelogs

## afterAddToChangelog
## afterChangelog

Ran after the `changelog` command adds the new release notes to `CHANGELOG.md`.
Useful for getting extra commits into a release before publishing.
Expand All @@ -83,7 +83,7 @@ Useful for getting extra commits into a release before publishing.
- `releaseNotes` - generated release notes for the release

```ts
auto.hooks.afterAddToChangelog.tap(
auto.hooks.afterChangelog.tap(
"MyPlugin",
async ({ currentVersion, commits, releaseNotes, lastRelease }) => {
// do something
Expand Down