ghh

command module
v0.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 19, 2023 License: ISC Imports: 6 Imported by: 0

README

ghh - GitHub Helper tool

create-project-issue

Create project issue creates a new draft issue in a GitHub project board. Metadata can be added in the form of fields and users can be assigned.

The command takes two inputs: a path to an issue body (markdown or plain text) and a path to a JSON document of metadata. The metadata file looks like this:

{
    "organization": "<org>",
    "user": "<login>",
    "projectNumber": 42,
    "issueTitle": "<your issue title>",
    "assignees": [
        "<login>"
    ],
    "fields": {
        "Status": "<board column>",
        "field1": "value1",
        "field2": "value2"
    }
}

Notice that either organization or user, and projectNumber as well as issueTitle are required fields.

The project number is part of the URL of your target project board.

GitHub project board URL

For boards with columns, the column is also a field. You can find the field name and the possible values in your project settings.

GitHub project settings

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
cmd

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
JackTT - Gopher 🇻🇳