Skip to content

Commit 47f35f4

Browse files
authored
rename octokit-create-pull-request to octokit-plugin-create-pull-request (gr2m#33)
BREAKING CHANGE: the npm package has been renamed from `octokit-create-pull-request` to `octokit-plugin-create-pull-request`
1 parent c13da07 commit 47f35f4

File tree

6 files changed

+25
-23
lines changed

6 files changed

+25
-23
lines changed

CODE_OF_CONDUCT.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@ In the interest of fostering an open and welcoming environment, we as contributo
88

99
Examples of behavior that contributes to creating a positive environment include:
1010

11-
* Using welcoming and inclusive language
12-
* Being respectful of differing viewpoints and experiences
13-
* Gracefully accepting constructive criticism
14-
* Focusing on what is best for the community
15-
* Showing empathy towards other community members
11+
- Using welcoming and inclusive language
12+
- Being respectful of differing viewpoints and experiences
13+
- Gracefully accepting constructive criticism
14+
- Focusing on what is best for the community
15+
- Showing empathy towards other community members
1616

1717
Examples of unacceptable behavior by participants include:
1818

19-
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20-
* Trolling, insulting/derogatory comments, and personal or political attacks
21-
* Public or private harassment
22-
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23-
* Other conduct which could reasonably be considered inappropriate in a professional setting
19+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
- Trolling, insulting/derogatory comments, and personal or political attacks
21+
- Public or private harassment
22+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
- Other conduct which could reasonably be considered inappropriate in a professional setting
2424

2525
## Our Responsibilities
2626

@@ -34,7 +34,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe
3434

3535
## Enforcement
3636

37-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at coc+octokit-plugin-[email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
3838

3939
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
4040

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# octokit-create-pull-request
1+
# octokit-plugin-create-pull-request
22

33
> Octokit plugin to create a pull request with multiple file changes
44
5-
[![@latest](https://img.shields.io/npm/v/octokit-create-pull-request.svg)](https://www.npmjs.com/package/octokit-create-pull-request)
6-
[![Build Status](https://travis-ci.com/gr2m/octokit-create-pull-request.svg?branch=master)](https://travis-ci.com/gr2m/octokit-create-pull-request)
7-
[![Greenkeeper](https://badges.greenkeeper.io/gr2m/octokit-create-pull-request.svg)](https://greenkeeper.io/)
5+
[![@latest](https://img.shields.io/npm/v/octokit-plugin-create-pull-request.svg)](https://www.npmjs.com/package/octokit-plugin-create-pull-request)
6+
[![Build Status](https://travis-ci.com/gr2m/octokit-plugin-create-pull-request.svg?branch=master)](https://travis-ci.com/gr2m/octokit-plugin-create-pull-request)
7+
[![Greenkeeper](https://badges.greenkeeper.io/gr2m/octokit-plugin-create-pull-request.svg)](https://greenkeeper.io/)
88

99
Features
1010

@@ -20,7 +20,7 @@ Update or create two files with a single commit
2020

2121
```js
2222
const { Octokit } = require("@octokit/core");
23-
const createPullRequest = require("octokit-create-pull-request");
23+
const createPullRequest = require("octokit-plugin-create-pull-request");
2424

2525
const MyOctokit = Octokit.plugin(createPullRequest);
2626

lib/create-pull-request.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ async function createPullRequest(
1111
});
1212

1313
if (!response.data.permissions) {
14-
throw new Error("[octokit-create-pull-request] Missing authentication");
14+
throw new Error(
15+
"[octokit-plugin-create-pull-request] Missing authentication"
16+
);
1517
}
1618

1719
if (!base) {

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "octokit-create-pull-request",
2+
"name": "octokit-plugin-create-pull-request",
33
"version": "0.0.0-development",
44
"description": "Octokit plugin to create a pull request with multiple file changes",
55
"main": "index.js",
@@ -26,10 +26,10 @@
2626
},
2727
"repository": {
2828
"type": "git",
29-
"url": "https://github.com/gr2m/octokit-create-pull-request.git"
29+
"url": "https://github.com/gr2m/octokit-plugin-create-pull-request.git"
3030
},
3131
"bugs": {
32-
"url": "https://github.com/gr2m/octokit-create-pull-request/issues"
32+
"url": "https://github.com/gr2m/octokit-plugin-create-pull-request/issues"
3333
},
34-
"homepage": "https://github.com/gr2m/octokit-create-pull-request#readme"
34+
"homepage": "https://github.com/gr2m/octokit-plugin-create-pull-request#readme"
3535
}

test/missing-authentication-test.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ test("invalid auth", async (t) => {
4949
} catch (error) {
5050
t.equal(
5151
error.message,
52-
"[octokit-create-pull-request] Missing authentication"
52+
"[octokit-plugin-create-pull-request] Missing authentication"
5353
);
5454
}
5555
});

0 commit comments

Comments
 (0)