https://github.com/hamxabaig/new-github-pull-request-url
Create a URL for new pull requests with prefilled title, body, assignee etc
https://github.com/hamxabaig/new-github-pull-request-url
automation generate-urls pull-request url url-generator
Last synced: 9 months ago
JSON representation
Create a URL for new pull requests with prefilled title, body, assignee etc
- Host: GitHub
- URL: https://github.com/hamxabaig/new-github-pull-request-url
- Owner: hamxabaig
- License: mit
- Created: 2018-12-25T18:44:36.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-03-20T04:37:28.000Z (almost 6 years ago)
- Last Synced: 2025-03-23T21:16:28.555Z (10 months ago)
- Topics: automation, generate-urls, pull-request, url, url-generator
- Language: JavaScript
- Size: 5.86 KB
- Stars: 8
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# new-github-pull-request-url [](https://travis-ci.com/hamxabaig/new-github-pull-request-url)
> Create a URL for new pull requests in repo with prefilled title, body, assignee etc
## Install
```
$ npm install new-github-pull-request-url
```
## Usage
```js
const newGithubPullRequestUrl = require('new-github-pull-request-url');
const url = newGithubPullRequestUrl({
compareTo: 'rocket-branch',
repo: 'abc/foo-repo',
title: 'this-is-awesome'
});
//=> https://github.com/abc/foo-repo/compare/master...rocket-branch?quick_pull=1&title=this-is-awesome
```
## API
### newGithubPullRequestUrl(options)
#### options
Type: `Object`
##### repo
Type: `string`
Required: `true`
Repo handle of github e.g `foo/bar-repo`
##### compareTo
Type: `string`
Required: `true`
The branch to compare with base branch. (This is your feature branch)
##### title
Type: `string`
Required: `false`
The pull request title. If not provided, Github will automatically make the last commit as title
##### base
Type: `string`
Default: `master`
The branch to which your feature branch will be merged.
##### body
Type: `string`
The body of pull request.
##### assignee
Type: `string`
The user to assign this pull request to.
##### template
Type: `string`
The template to use for the body of pull request. If you have only 1 template, you don't need to provide this.
## Reference
[About-automation-for-issues-and-pull-requests-with-query-parameters](https://help.github.com/articles/about-automation-for-issues-and-pull-requests-with-query-parameters)
## Related
- [new-github-issue-url](https://github.com/sindresorhus/new-github-issue-url) - Generate a URL for opening a new GitHub issue with prefilled title, body, and other fields
- [new-github-release-url](https://github.com/sindresorhus/new-github-release-url) - Generate a URL for opening a new GitHub release with prefilled tag, body, and other fields
## License
MIT © Made with :heart: & :coffee: [Hamza Baig](http://hamxabaig.github.io)