Skip to content

Latest commit

 

History

History
120 lines (80 loc) · 2.9 KB

Readme.md

File metadata and controls

120 lines (80 loc) · 2.9 KB
Raw

🦀 Github PR URL Generator

Welcome to the GitHub PR URL Generator! This command-line tool simplifies the creation of pull request for your GitHub repositories.

To create a PR quickly, run the command and click the generated link.

ghpr_demo.mp4

🚀 Examples of Usage

Here are some examples of how to use the ghpr command:

  1. Generate a pull request URL with a specified repository, source branch, and destination branch:
ghpr --repo owner/repo --src my-feature-branch --dest main
  1. Generate a pull request URL with additional parameters like title and body:
ghpr --repo owner/repo --src main --dest feature-branch --title "Fix bug" --body "This PR fixes the bug."
  1. Generate a pull request URL using values from a .ghprrc file (destination is picked up from the file):
ghpr --src feature-branch --title "Add new feature"

.ghprrc file:

[defaults]
dest="master"
repo="ArunVenkata/ghpr"

Generated URL: https://github.com/ArunVenkata/ghpr/compare/feature-branch...master?quick_pull=1&title=Add%20new%20feature

📦 Installation Instructions

  1. Ensure you have Rust installed on your machine.

  2. Run the following command

cargo install ghpr

🖥️ Install from Source

  1. Clone the repository:
git clone https://github.com/ArunVenkata/ghpr.git
cd ghpr

  1. Ensure you have Rust installed on your machine.

  2. Build the project:

cargo build --release
  1. Run the tool:
./target/release/ghpr --help

⚙️ About the .ghprrc File

The .ghprrc file allows you to set default values for various parameters used in the ghpr command. This file should be located in your project directory and formatted as follows:

[defaults]
repo = "owner/repo"
src = "feature-branch"
dest = "main"
title = "Your PR Title"
body = "Description of the pull request."
labels = "bug,enhancement"
milestone = "1.0"
assignees = "username1,username2"
projects = "project1,project2"
template = "template_name"

Note: If src is not specified, it automatically refers to your current git branch (provided your current directory is a git repository)

Run ghpr --help for more information on the supported parameters.

🤝 Contributing Guidelines

If you would like to contribute to the project, please follow these guidelines:

  1. Fork the repository and create your feature branch:
git checkout -b feature/new-feature
  1. Commit your changes:
git commit -m "Add some feature"
  1. Push to the branch:
git push origin feature/new-feature
  1. Open a pull request and describe your changes.

🎉 License

This project is licensed under the MIT License. See the LICENSE file for details.