github-notify

command module
v0.1.0 Latest Latest
Warning

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

Go to latest
Published: Aug 23, 2022 License: MIT Imports: 1 Imported by: 0

README

github-notify

Go Report Card Test Release

This application parse GitHub repository pull requests by title and authors and send notification to Slack channel about pending reviews.

Configure

Create in Your home directory tile named .github-notify.yaml with content

token: ghp_github_token
reviewers:
  - github: pawelgarbarz
    slack: garbarz.pawel
webhook-url: https://hooks.slack.com/some-random-code
jira-project: JIRA
github-repo: pawelgarbarz/github-notify

parameters:

  • token - GitHub token with access to repository pull requests
  • reviewers - list of team members who want to be informed about pull requests
    • github - user GitHub login
    • slack - user Slack login
  • webhook-url - Slack channel webhook url
  • jira-project - Jira project code, can be overwritten by parameter -p, --jira-project
  • github-repo - GitHub repository in format brand/name, can be overwritten by parameter -u, --github-repo

Run command

Usage:
  github-notify pull-request [flags]

Flags:
  -d, --debugLevel int   debug level 0..3
  -h, --help             help for pull-request

Global Flags:
      --config string         config file (default is $HOME/.github-notify.yaml)
  -u, --github-repo string    github repository brand/name
  -p, --jira-project string   jira project code

Documentation

Overview

Copyright © 2022 NAME HERE <EMAIL ADDRESS>

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL