Skip to content

Commit

Permalink
Merge pull request #17 from Updater/semantic-release-13
Browse files Browse the repository at this point in the history
docs: replace references to `publish` plugin w/ `generateNotes`
  • Loading branch information
pmowrer authored Feb 11, 2018
2 parents 829d0f5 + 830d931 commit 431e695
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 6 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,6 @@ E.g., `package.json`:
}
```

[Other ways of configuring `branch`.](https://github.com/semantic-release/semantic-release/blob/caribou/docs/usage/configuration.md#configuration.)

#### Advanced

Due to limitations in how plugins may be composed, `semantic-release-github-pr` must unfortunately hard-code the [`analyzeCommits` plugin](#analyzecommits) (see discussion [here](https://github.com/semantic-release/semantic-release/issues/550)).
Expand Down Expand Up @@ -117,7 +115,7 @@ Running `semantic-release-github-pr` is equivalent to running `semantic-release`
{
"release": {
"analyzeCommits": "semantic-release-github-pr",
"publish": "semantic-release-github-pr",
"generateNotes": "semantic-release-github-pr",
"verifyConditions": [
"@semantic-release/github",
"semantic-release-github-pr"
Expand All @@ -128,7 +126,7 @@ Running `semantic-release-github-pr` is equivalent to running `semantic-release`

#### verifyConditions

Used as a hook for cleaning up previous changelog PR comments made by the `publish` plugin, keeping it from flooding a PR with (eventually stale) changelog comments over time.
Used as a hook for cleaning up previous changelog PR comments made by the `generateNotes` plugin, keeping it from flooding a PR with (eventually stale) changelog comments over time.

It's recommended to pair this package's `verifyConditions` with that of [`@semantic-release/github`](https://github.com/semantic-release/github#verifyconditions).

Expand All @@ -138,6 +136,6 @@ Used as a hook to create a "no release" comment on a matching PR, if `semantic-r

See the [`Release config`](#release-config) section for how to configure a custom `analyzeCommits` plugin and/or set options.

#### publish
#### generateNotes

Creates a comment on matching PRs with the changelog for the release that would result from merging.
2 changes: 1 addition & 1 deletion src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ const analyzeCommits = wrapPlugin(
const { dryRun, githubRepo, pullRequests } = pluginConfig;
const nextRelease = await plugin(pluginConfig, config);

if (!nextRelease && !dryRun) {
if (!nextRelease) {
await pullRequests.forEach(async pr => {
const { number } = pr;
const createChangelogOnPr = createChangelog(pluginConfig, config);
Expand Down

0 comments on commit 431e695

Please sign in to comment.