Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Chemaclass committed Sep 15, 2024
1 parent ae85545 commit 1569f02
Showing 1 changed file with 16 additions and 10 deletions.
26 changes: 16 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,28 @@
A bash script that helps create your PRs.
It normalised the PR title, description, assignee by default and initial label based on your branch name.

### Current support
## Current support

- **GitHub** requires https://cli.github.com/
- **GitLab** requires https://docs.gitlab.com/ee/editor_extensions/gitlab_cli/

> These are needed to access your client via the terminal, and they are independent of this script.
### Extra arguments

Any additional argument will be passed to `gh` or `glab` tool.

```bash
# Create a draft PR
./create-pr --draft

# Create a draft PR with an overridden title
./create-pr --draft --title="Custom Title"
```

* GitHub: https://cli.github.com/manual/gh_pr_create
* GitLab: https://gitlab.com/gitlab-org/cli/-/blob/main/docs/source/mr/create.md

## Installation

Download the latest `single executable script` on the [Releases page](https://github.com/Chemaclass/bash-create-pr/releases), or build it yourself.
Expand Down Expand Up @@ -110,15 +125,6 @@ PR_LABEL_MAPPING="docs:documentation; fix|bug|bugfix|hotfix:bug; default:enhance

- `BASE_BRANCH` or `main` by default

## Extra arguments

Any additional argument will be passed to `gh` or `glab` tool.

> Eg: `create-pr --draft` will create a draft PR.
* GitHub: https://cli.github.com/manual/gh_pr_create
* GitLab: https://gitlab.com/gitlab-org/cli/-/tree/main/docs/source/mr

## HINTS

- Add to your composer, npm or similar a script pointing to the `create-pr`
Expand Down

0 comments on commit 1569f02

Please sign in to comment.