Skip to content

Instantly share code, notes, and snippets.

@jplew
Created October 21, 2019 02:58
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save jplew/a5ae2c3a642f9ccd7be8db5045031d24 to your computer and use it in GitHub Desktop.
Save jplew/a5ae2c3a642f9ccd7be8db5045031d24 to your computer and use it in GitHub Desktop.
Github README

πŸ›  CTO.ai Github Ops πŸš€

A collection of ops to manage your Github workflow

Requirements πŸ”‘

  • Create Github access token

    • You would need the Github access token in order to run any Github command. Find the steps to create the access token here.

    • Remember to select repo and admin scopes to grant to this access token.

    • Copy the access token and provide it when prompted.

    • Your remote origin must be set to a valid Github repo.

Available Ops πŸ’‘

All the commands start with ops run github. From there, you would use the following commands to manage your Github flow.

  • repo:create

Initializes a new git repo in the current working directory and pushes to the user's selected organization or personal Github repository.

  • repo:clone

Clones a remote repo that you are a contributor on to your current working directory.

  • issue:create

Creates a new issue in Github. Current working directory must be a repo either cloned or created using the repo:create or repo:clone commands.

  • issue:list

Lists all the issues the user has access to. If the current working directory is a repo in github then the issues are scope by the repo otherwise it displays all issues that you are assigned to or created by you etc.

  • issue:search

Searches all issues in Github for your current working directory by selected filters. User can pass optional query string argument in form of [-q <+querystring> | --query <+querystring>] for additional filters.
Please check Github querystring for detailed info

  • issue:start

Lists all issues in Github for your current working directory. Selecting a issue will checkout a branch for that issue and set the upstream in github.

  • issue:save

Adds all unstaged changes, commits and pushes to Github for the current working branch.

  • issue:done

Converts the current working issue into a pull-request and allows you to tag reviewers.

  • pulls:list

Lists all the pull requests for a given repo. The current working directory has to be a repo.

  • label:add

Allows you to create a new label in a repo and sync the label addition across other repos in the organization.

  • label:edit

Allows you to edit a label and sync the edit across other repos in the organization.

  • label:remove

Allows you to remove label from a repo and sync the removal across other repos in the organization.

  • label:sync

Allows you to sync up labels from one base repo to any other repo(s) that you have access to. The op will check for any missing labels in the targeted repo(s) and add in as necessary.

  • token:update

Allows you to update your Github access token.

Debugging Github op

Use DEBUG=github:* ops run github <command> in order to run the op in debug mode

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment