githubasana

README

GitHub Asana Request Review Action

When a reviewer is assigned on GitHub, creates a review subtask on an Asana task specified in a pull request description.

Screenshots

• Before create a pull request.

• Create a pull request.

• After assigned someone as code reviewer on the pull request.

Documentation

Overview

Package githubasana provides GitHub and Asana pull request task integration.

Index

• func AddCodeReviewSubtask(client *asana.Client, taskID string, prID int, requester *Account, ...) (*asana.Task, error)
• func AddCodeReviewSubtaskComment(client *asana.Client, subtask *asana.Task, requester *Account, ...) (*asana.Story, error)
• func AddPullRequestCommentToTask(client *asana.Client, taskID string, requester *Account, ...) (*asana.Story, error)
• func FindSubtaskByName(client *asana.Client, taskID string, findString string) (*asana.Task, error)
• func FindTaskComment(client *asana.Client, taskID string, findString string) (*asana.Story, error)
• func NextBusinessDay(n int, base time.Time, holidays map[string]bool) time.Time
• func UpdateCodeReviewSubtask(client *asana.Client, subtask *asana.Task, requester *Account, ...) error
• func UpdateTaskComment(client *asana.Client, storyID string, requester *Account, ...) (*asana.Story, error)
• type Account
  • func NewAccount(client *asana.Client, userGID string, githubLogin string) (*Account, error)
  • func NewNoAsanaAccount(githubLogin string) *Account
  • func (u *Account) GetUserPermalink() string
  • func (u *Account) String() string
• type AsanaGID
• type Config
  • func LoadConfig(data []byte) (*Config, error)
• type GithubLogin
• type Handler
  • func NewHandler(conf *Config, asanaClient *asana.Client, githubClient *github.Client) *Handler
  • func (h *Handler) Handle(eventName string, eventPayload []byte) error

Functions

func AddCodeReviewSubtask

func AddCodeReviewSubtask(client *asana.Client, taskID string, prID int, requester *Account, reviewer *Account, dueDate asana.Date, pr *github.PullRequestEvent) (*asana.Task, error)

func AddCodeReviewSubtaskComment

func AddCodeReviewSubtaskComment(client *asana.Client, subtask *asana.Task, requester *Account, reviewer *Account, pr *github.PullRequestReviewEvent) (*asana.Story, error)

func AddPullRequestCommentToTask

func AddPullRequestCommentToTask(client *asana.Client, taskID string, requester *Account, pr *github.PullRequestEvent) (*asana.Story, error)

func FindSubtaskByName

func FindSubtaskByName(client *asana.Client, taskID string, findString string) (*asana.Task, error)

FindSubtaskByName finds a subtask which contains specified string.

func FindTaskComment

func FindTaskComment(client *asana.Client, taskID string, findString string) (*asana.Story, error)

FindTaskComment finds a story which contains specified string.

func NextBusinessDay

func NextBusinessDay(n int, base time.Time, holidays map[string]bool) time.Time

NextBusinessDay returns next n business day. If n is zero, it returns most recent business day including `base` day.

func UpdateCodeReviewSubtask

func UpdateCodeReviewSubtask(client *asana.Client, subtask *asana.Task, requester *Account, pr *github.PullRequestEvent) error

func UpdateTaskComment

func UpdateTaskComment(client *asana.Client, storyID string, requester *Account, pr *github.PullRequestEvent) (*asana.Story, error)

Types

type Account

type Account struct {
	Name         string
	AsanaUserGID string
	GitHubLogin  string
}

func NewAccount

func NewAccount(client *asana.Client, userGID string, githubLogin string) (*Account, error)

func NewNoAsanaAccount

func NewNoAsanaAccount(githubLogin string) *Account

func (*Account) GetUserPermalink

func (u *Account) GetUserPermalink() string

func (*Account) String

func (u *Account) String() string

type AsanaGID

type AsanaGID = string

type Config

type Config struct {
	DueDate  int                      `yaml:"due_date"`
	Holidays map[string]bool          `yaml:"holidays"`
	Accounts map[GithubLogin]AsanaGID `yaml:"accounts"`
}

func LoadConfig

func LoadConfig(data []byte) (*Config, error)

type GithubLogin

type GithubLogin = string

type Handler

type Handler struct {
	// contains filtered or unexported fields
}

func NewHandler

func NewHandler(conf *Config, asanaClient *asana.Client, githubClient *github.Client) *Handler

func (*Handler) Handle

func (h *Handler) Handle(eventName string, eventPayload []byte) error