gitip
v1.0.2
Published
auto generate git issue and pull request
Downloads
4
Maintainers
Readme
Installation
#not install
npx gitip
#install
npm install -g gitip
gitip
Before start
- please make the fork branch first.
// <<required varibales>>
// Basically it uses an env file according to a "NODE_ENV" varibale.
// If your environment is "development", then gitip uses the target env file.
// If there isn't, a default file is ".env"
GIT_ACCESS_TOKEN = git access token.
REMOTE_REPO_OWNER = the name of remote branch owner
FORK_REPO_OWNER = the name of fork branch owner
REPO_NAME = the repository name;
BRANCH_NAME = the base(destination) branch name
TEMPLATE_TITLE_PLACEHOLDER = (optional) issue template title placeholder
If you want to use your template, you should set the TEMPLATE_TITLE_PLACEHOLDER
varibale on your .env file. It will uses that variable as an issue title placeholder.
usage
🖊️ 1. create an issue
🖊️ 2. create a pull request
First of all, you need to commit your change
And, just select "create a pull request"
- the title of a pull request comes from the latest commit
- the body of a pull request comes from the latest commit either
- If the pull request closed, it would close the issue together
⚠️ Caveat If you want to use "close" keyword to close related issue together, the base(destination) branch should be a default branch
🖊️ 3. Synchronize a fork branch with origin branch
If you need to update your fork branch whenever origin is updated, you can do it without visiting to your fork branch manually
😩 Not this
😀 But this
🖊️ 4. Remove unused issue branches
When you are using gitip, maybe you would face the situation that there are bunch of redundant issue branches like below
1. 😩 local debris
2. 😩 fork debris
If you should remove the unused branches, it takes time and effort. So, for you, you can remove them all at once like below
4. 😀 like this
As a result, you meat the erased clean space