Skip to content

Commit

Permalink
Update readme with video
Browse files Browse the repository at this point in the history
  • Loading branch information
Baarsgaard committed Aug 25, 2023
1 parent ff8845c commit 3d678c8
Showing 1 changed file with 36 additions and 33 deletions.
69 changes: 36 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# Jig

(Ji)ra (G)it<br>
Most if not all my work at $day_job is coordinated through and logged in Jira.<br>
(Ji)ra (G)it
Most if not all my work at $day_job is coordinated through and logged in Jira.
additionally I'm not a fan of doing simple tasks in the Jira UI..

I looked at existing Jira CLI tools, but none solve my exact use case.<br>
I looked at existing Jira CLI tools, but none solve my exact use case.
Hence, [Jig](https://www.youtube.com/watch?v=3JcmQONgXJM)!

Jig is opinionated towards working with a healthy "Per issue" branching model, also known as "My workflow".<br>
Jig is opinionated towards working with a healthy "Per issue" branching model, also known as "My workflow".
It therefore includes options and features I need to support that.

Primarily:<br>
Creating new branches from Jira issues with(out) summaries.<br>
Quickly logging time and Commenting on the issue found in the branch name.<br>
Moving issues from one status to the next.
Primarily:
Creating new branches from Jira issues with(out) summaries.
Quickly logging time and Commenting on the issue found in the branch name.
Moving issues from one status to the next.

## Installation

Expand All @@ -30,7 +30,7 @@ add `--features fuzzy` to enable `fuzzy` selections (Will also enable `cloud` on
## Configuration

Supports global and local repository config files.<br>
Supports global and local repository config files.
If both exist, they are merged with the local taking priority.

See [example_config.toml](./example_config.toml)
Expand All @@ -42,45 +42,48 @@ jig init [--all]

## Usage

[![asciicast](https://asciinema.org/a/604710.png)](https://asciinema.org/a/604710)

```bash
jig --help
jig <COMMAND> --help
# A Jira CLI integration with Git
#
# Usage: jig
# jig <COMMAND>
#
# Commands:
# branch Create and checkout branch using issue key with(out) summary as branch name
# comment Create comment on a Jira Issue
# configs List config file locations
# init Initialise config file(s)
# log Create a work log entry on a Jira issue
# move Move ticket through transitions
# open Open issue using BROWSER var
# help Print this message or the help of the given subcommand(s)
#
# Options:
# -h, --help Print help
# -V, --version Print version
$ jig help

A Jira CLI integration with Git

Usage: jig
jig <COMMAND>

Commands:
branch Create and checkout branch using issue key with(out) summary as branch name
comment Create comment on a Jira Issue
configs List config file locations
init Initialise config file(s)
log Create a work log entry on a Jira issue
move Move ticket through transitions
open Open issue using BROWSER var
upgrade Download and install latest version (Cloud only)
help Print this message or the help of the given subcommand(s)

Options:
-h, --help Print help
-V, --version Print version
```

Initialise a workspace or global config file:
```bash
jig init
# --all to override defaults.
# --all to alter default behaviour
```
The workspace config file (`.jig.toml`) will be created at the root of the repository or if not found, in the current directory.
The workspace config file (`.jig.toml`) will be created at the root of the current repository or if not found, in the current directory.
The global file is created according to [XDG Conventions](https://docs.rs/etcetera/latest/etcetera/#conventions)

Be on or create a branch with an issue key in the name.<br>
Be on or create a branch with an issue key in the name.
```bash
jig branch
```

Work on that branch and commit as normal.

Log work/Comment progress as you work normally.<br>
Log work/Comment progress as you work normally.
```bash
# Optionally comment progress as you work.
jig comment "Note: Changed impl due to X"
Expand Down

0 comments on commit 3d678c8

Please sign in to comment.