https://github.com/connected-web/prnow
Command line tool to create a PR now - minimal fuss - automated commit, push, and PR using hub
https://github.com/connected-web/prnow
Last synced: 4 months ago
JSON representation
Command line tool to create a PR now - minimal fuss - automated commit, push, and PR using hub
- Host: GitHub
- URL: https://github.com/connected-web/prnow
- Owner: connected-web
- Created: 2021-04-02T10:51:56.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-07-01T23:10:25.000Z (12 months ago)
- Last Synced: 2025-10-22T05:49:18.863Z (8 months ago)
- Language: TypeScript
- Size: 553 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PR Now
Command line tool to create a PR now - minimal fuss - automated commit, push, and PR using hub
Taking the effort out of making pull requests, by linking together branch names, PR titles, and tickets by running one simple command.
## So what is PR Now?
PR Now is a command line tool that automates a streamlined workflow for making pull requests in the blink of an eye. PR Now assumes your project uses github, and you have a Github issue or Jira ticket associated with the change you're working on. If that's the case, then amazing; you're in for one crazily optimised PR experience!
## Prereqsuites
- `node js > 22` installed : https://nodejs.org/en/
- `gh > 2.x` installed : https://cli.github.com/
- `git > 2` installed : https://git-scm.com/downloads
- A project checked out from `github` : https://github.com/
## Environment Variables
- `GITHUB_TOKEN` set on your environment to a developer key for `gh` to talk to `github`
### Optional
- `PRNOW_JIRA_BASE_URL` set on your environment to integrate with Jira e.g. `https://connected-web.atlassian.net`
- `PRNOW_JIRA_API_KEY` set on your environment to use an API key with Jira
- `PRNOW_JIRA_CLIENT_KEY` set on your environment to point a private key PEM for use with SSL header accesss to Jira
## What does PR Now do?
PR Now will attempt to:
- Create a commit title out of the current arguments (if multiple arguments are supplied)
- Look at the current branch name, and attempt to extract a ticket ID or issue number
- Try to find an issue from github based on the supplied ID and extract its title
- Try and find a Jira ticket based on the supplied ID and extract its title
- Create and checkout a branch based on the ticket ID
- Commit any unstaged files with the equivalent message "TICKET-24 Title of ticket"
- Push any changes to the remote branch; creating the remote branch if necessary
- Use `gh` to create a PR in github with a title, and a link to the ticket in the description
- Use `gh` to open a browser with the new PR so you can review and share with friends
That's a lot of things! Think through how you would normally create a Pull Request - write down all the steps.
That's what this tool is trying to do.
## Basic Commands
Create a PR using a Github Issue:
```
prnow 12
```
Create a PR using a Jira ticket:
```
prnow TICKET-123
```
Create a PR using a commit message:
```
prnow "Update the README"
```
To reset to default branch and pull any changes from the remote:
```
prnow reset
```
## Quick setup
Before setting an alias you can just run:
```
npx github:connected-web/prnow TICK-24
```
## Alias use
Modify your `~/.profile`, add:
```
alias prnow="npx github:connected-web/prnow"
```
Then run `source ~/.profile` or restart your console.
You should then be able to use `prnow` from anywhere on the command line.
## Jira Integration Setup
From Jira's [basic-auth-for-rest-apis](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/#supply-basic-auth-headers):
>1. Generate an API token for Jira using your Atlassian Account.
>2. Build a string of the form useremail:api_token.
>3. BASE64 encode the string.
> - `echo -n user@example.com:api_token_string | base64`
>4. Supply an Authorization header with content Basic followed by the encoded string.
To supply the authorization token, set: `PRNOW_JIRA_API_TOKEN` on your env; for example by editing `~/.profile` and reloading your terminal.
Also, you'll need to specify which Jira instance you are connected to.
To make this work set:
- `PRNOW_JIRA_BASE_URL` e.g. for testing this project uses `https://connected-web.atlassian.net`
Example `~/.profile` changes:
```
export PRNOW_JIRA_BASE_URL="https://connected-web.atlassian.net"
export PRNOW_JIRA_API_TOKEN="XYZabc123=="
alias prnow="npx github:connected-web/prnow"
```
There is currently no way to set up multiple access tokens based on project - if this is of interest to you; please raise an issue. One solution might be to makhee separate aliases for t command - setting the appropriate environment variables just prior to command execution.
## Usage (TypeScript, no build step)
You can now run PR Now directly from TypeScript source using [tsx](https://npm.im/tsx):
```sh
npx tsx cli.ts [commit message]
```
For example:
```sh
npx tsx cli.ts TICKET-123 "Add new feature"
```
You can also use all previous features and environment variables as before.
## Examples
### Example 1
```
prnow 14
```
This would:
- Find "Add support for finding ticket info from github issues" from https://github.com/connected-web/prnow/issues/14
- Create and checkout the branch `#14/add-support-for-finding-ticket-info-from-github-issues` in the local repo
- Commit all unsaved files with the message "#14 Add support for finding ticket info from github issues"
- Create an upstream branch and push the changes
- Create a draft Pull Request in Github with the title "#14 Add support for finding ticket info from github issues"
- Open the Pull Request in your web browser for you to review
### Example 2
```
On branch: #14/add-support-for-finding-ticket-info-from-github-issues
prnow
```
This would:
- Look at the current branch name, and extract `14` as the issue ID for this commit
- Find "Add support for finding ticket info from github issues" from https://github.com/connected-web/prnow/issues/14
- Create and checkout the branch `#14/add-support-for-finding-ticket-info-from-github-issues` in the local repo
- Commit all unsaved files with the message "#14 Add support for finding ticket info from github issues"
- Create an upstream branch and push the changes
- Create a draft Pull Request in Github with the title "#14 Add support for finding ticket info from github issues"
- Open the Pull Request in your web browser for you to review
### Example 3
```
On default branch:
prnow Update the README
```
This would:
- Create a commit title out of "Update the README"
- Create and checkout the branch `Update/update-the-readme`
- Commit all unsaved files with the message "Update the README"
- Create an upstream branch and push the changes
- Create a draft Pull Request in Github with the title "Update the README"
- Open the Pull Request in your web browser for you to review
### Example 4
```
On branch WORKOP-123/a-recently-merged-feature
prnow reset
```
This would:
- Checkout the local default branch
- Pull and rebase any changes to update your local repository