GitHub

This is the cog guide for the github cog. You will find detailed docs about usage and commands.

[p] is considered as your prefix.

Note

To use this cog, you will need to install and load it.

Usage

Create, comment, labelify and close GitHub issues.

This cog is only for bot owners. I made it for managing issues on my cog repo as a small project, but it certainly could be used for other situations where you want to manage GitHub issues from Discord.

If you would like a way to search or view issues, I highly recommend Kowlin’s approved githubcards cog (on the repo https://github.com/Kowlin/Sentinel)

At present, this cannot support multiple repos.

PRs are mostly supported. You can comment on them or close them but not merge them or create them.

Get started with the gh howtoken command to set your GitHub token. You don’t have to do this if you have already set it for a different cog, eg githubcards. Then set up with gh setrepo.

Commands

gh

Note

This command is locked to the bot owner.

Syntax

[p]gh

Tip

Alias: github

Description

Command to interact with this cog.

All commands are owner only.

gh addlabels

Syntax

[p]gh addlabels <issue>

Tip

Alias: gh addlabel

Description

Interactive command to add labels to an issue or PR.

gh close

Syntax

[p]gh close <issue>

Description

Close an issue or PR.

gh comment

Syntax

[p]gh comment <issue> <text>

Description

Comment on an issue or PR.

gh commentclose

Syntax

[p]gh commentclose <issue> <text>

Description

Comment on, then close, an issue or PR.

gh howtoken

Syntax

[p]gh howtoken

Description

Instructions on how to set up a token.

gh open

Syntax

[p]gh open <title>

Description

Open a new issue. Does NOT reopen.

gh removelabels

Syntax

[p]gh removelabels <issue>

Tip

Alias: gh removelabel

Description

Interactive command to remove labels from an issue or PR.

gh setrepo

Syntax

[p]gh setrepo <slug>

Description

Set up a repo to use as a slug (USERNAME/REPO).