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

fix: clean up reviewer related configs #707

Merged
merged 1 commit into from
Mar 6, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -326,9 +326,7 @@ You can assign reviewers on the PR.

```js
module.exports = {
pullRequestReviewer: "user-name-or-team-name"
// or
pullRequestReviewer: ["user1", "user2", "user3"]
pullRequestReviewers: ["user1", "user2", "user3"]
};
```

Expand Down
4 changes: 2 additions & 2 deletions packages/shipjs-lib/src/lib/config/defaultConfig.js
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ export default {
];
return lines.join('\n');
},
pullRequestReviewer: undefined,
pullRequestTeamReviewer: undefined,
pullRequestReviewers: undefined,
pullRequestTeamReviewers: undefined,
mergeStrategy: {
toSameBranch: ['master'],
// toReleaseBranch: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ const getDefaultParams = ({
formatPullRequestTitle,
formatPullRequestMessage,
remote: 'origin',
pullRequestReviewer: ['foo', 'bar'],
pullRequestReviewers: ['foo', 'bar'],
},
noBrowse,
dir: '.',
Expand Down
19 changes: 8 additions & 11 deletions packages/shipjs/src/step/prepare/createPullRequest.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ export default async ({
formatPullRequestTitle,
formatPullRequestMessage,
publishCommand,
pullRequestReviewer,
pullRequestTeamReviewer,
pullRequestReviewers,
pullRequestTeamReviewers,
remote,
monorepo,
} = config;
Expand Down Expand Up @@ -89,12 +89,6 @@ export default async ({
return {};
}

const reviewers = Array.isArray(pullRequestReviewer)
? pullRequestReviewer
: (pullRequestReviewer || '').split(',');
const teamReviewers = Array.isArray(pullRequestTeamReviewer)
? pullRequestTeamReviewer
: (pullRequestTeamReviewer || '').split(',');
const octokit = new Octokit({
auth: `token ${process.env.GITHUB_TOKEN}`,
});
Expand All @@ -109,13 +103,16 @@ export default async ({
base: destinationBranch,
});

if (reviewers.length > 0 || teamReviewers.length > 0) {
if (
pullRequestReviewers.length > 0 ||
pullRequestTeamReviewers.length > 0
) {
await octokit.pulls.createReviewRequest({
owner,
repo,
pull_number: number, // eslint-disable-line camelcase
reviewers,
team_reviewers: teamReviewers, // eslint-disable-line camelcase
reviewers: pullRequestReviewers,
team_reviewers: pullRequestTeamReviewers, // eslint-disable-line camelcase
});
}

Expand Down
8 changes: 2 additions & 6 deletions website/guide/useful-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,16 +180,12 @@ You can assign reviewers on the PR.

```js
module.exports = {
pullRequestReviewer: "user-login"
// or
pullRequestReviewer: ["user-login1", "user-login2", "user-login3"],
pullRequestReviewers: ["user-login1", "user-login2", "user-login3"],

...

// also
pullRequestTeamReviewer: "team-slug",
// or
pullRequestTeamReviewer: ["team-slug1", "team-slug2"],
pullRequestTeamReviewers: ["team-slug1", "team-slug2"],
};
```

Expand Down
18 changes: 13 additions & 5 deletions website/reference/all-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,20 +121,28 @@ beforeCommitChanges: ({ nextVersion, releaseType, exec, dir }) => {

This is a lifecycle hook which is executed right before `git commit` happens. You can put additional code like modifying some other files.

## `pullRequestReviewer`
## `pullRequestReviewers`

_default:_ `undefined`

You can put either a string or an array of strings.
You can put an array of strings.

```js
pullRequestReviewer: 'user-name-or-team-name';
// or
pullRequestReviewer: ['user1', 'user2', 'user3'];
pullRequestReviewers: ['user1', 'user2', 'user3'];
```

One thing you need to be aware of is, you cannot assign yourself as a reviewer. You can put github username of your team or colleagues.

## `pullRequestTeamReviewers`

_default:_ `undefined`

You can put an array of strings.

```js
pullRequestTeamReviewers: ['team-username1'];
```

## `mergeStrategy`

_default:_
Expand Down