Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jmrodri/gh2jira

A utility to copy a github issue to jira
https://github.com/jmrodri/gh2jira

Last synced: about 2 months ago
JSON representation

A utility to copy a github issue to jira

Awesome Lists containing this project

README

        

# gh2jira

Build Status:
[![Build Status][actions-img]](https://github.com/jmrodri/gh2jira/actions)
License:
[![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
Code coverage:
[![coveralls][coveralls-img]](https://coveralls.io/github/jmrodri/gh2jira?branch=main)

A utility that allows you to copy a Github issue to Jira

## Usage
There are 2 main subcommands `list` & `clone`. The `list` subcommand will
display all open github issues of the given project. The `clone` subcommand will
copy the given Github issue to your Jira instance.

```
$ ./gh2jira --help
github to jira issue cloner

Usage:
gh2jira [command]

Available Commands:
clone Clone given Github issues to Jira
completion Generate the autocompletion script for the specified shell
help Help about any command
list List Github issues

Flags:
-h, --help help for gh2jira

Use "gh2jira [command] --help" for more information about a command.
```

### `list` subcommand

The `list` subcommand will display all open github issues of the given project.
You can filter the list by milestone, assignee and/or labels.

Multiple labels can be supplied either as a comma separated list or multiple `--label` flags.

For example, `--label kind/bug,kind/documentation` or `--label kind/bug --label
kind/documentation`.

The `--milestone` flag requires the milestone ID. So click on your Github
Milestones tab and look at the ID in the URL, use that.

```
$ ./gh2jira list --help
List Github issues filtered by milestone, assignee, or label

Usage:
gh2jira list [flags]

Flags:
--assignee string username of the issue is assigned
-h, --help help for list
--label strings label i.e. --label "documentation,bug" or --label doc --label bug
--milestone string the milestone ID from the url, not the display name
--project string Github project to list e.g. ORG/REPO (default "operator-framework/operator-sdk")
```

### `clone` subcommand

The `clone` subcommand will copy the given Github issue to your Jira instance.
*WARNING!* This will write to your Jira instance, consider using the `--dryrun`
flag.

The `--dryrun` flag will print out the Jira issue it would send to Jira.

```
$ ./gh2jira clone --help
Clone given Github issues to Jira. WARNING! This will write to your jira instance. Use --dryrun to see what will happen

Usage:
gh2jira clone [ISSUE_ID ...] [flags]

Flags:
--dryrun display what we would do without cloning
--github-project string Github project to clone from e.g. ORG/REPO (default "operator-framework/operator-sdk")
-h, --help help for clone
--project string Jira project to clone to (default "OSDK")
```

[actions-img]: https://github.com/jmrodri/gh2jira/workflows/unit/badge.svg
[coveralls-img]: https://coveralls.io/repos/github/jmrodri/gh2jira/badge.svg?branch=main