github

package
v0.2.2 Latest Latest
Warning

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

 Go to latest Published: Apr 1, 2021 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func HashPayload 

func HashPayload(secret string, payloadBody []byte) string

HashPayload hashes the payload

func IsValidPayload 

func IsValidPayload(secret, headerHash string, payload []byte) bool

IsValidPayload validates the webhook payload

func Validate 

func Validate(secret, headerHash string, payload []byte) error

Validate validates the webhook payload

Types

type Client 

type Client struct {
	IntegrationConfig *cicdv1.IntegrationConfig
	K8sClient         client.Client
}

Client is a gitlab client struct

func (*Client) CanUserWriteToRepo added in v0.2.0 

func (c *Client) CanUserWriteToRepo(user git.User) (bool, error)

CanUserWriteToRepo decides if the user has write permission on the repo

func (*Client) DeleteWebhook 

func (c *Client) DeleteWebhook(id int) error

DeleteWebhook deletes registered webhook

func (*Client) GetUserInfo added in v0.1.4 

func (c *Client) GetUserInfo(userName string) (*git.User, error)

GetUserInfo gets a user's information

func (*Client) ListWebhook 

func (c *Client) ListWebhook() ([]git.WebhookEntry, error)

ListWebhook lists registered webhooks

func (*Client) ParseWebhook 

func (c *Client) ParseWebhook(header http.Header, jsonString []byte) (*git.Webhook, error)

ParseWebhook parses a webhook body for github

func (*Client) RegisterComment added in v0.2.0 

func (c *Client) RegisterComment(_ git.IssueType, issueNo int, body string) error

RegisterComment registers comment to an issue

func (*Client) RegisterWebhook 

func (c *Client) RegisterWebhook(url string) error

RegisterWebhook registers our webhook server to the remote git server

func (*Client) SetCommitStatus 

func (c *Client) SetCommitStatus(integrationJob *cicdv1.IntegrationJob, context string, state git.CommitStatusState, description, targetURL string) error

SetCommitStatus sets commit status for the specific commit

type Comment added in v0.2.0 

type Comment struct {
	Body      string       `json:"body"`
	CreatedAt *metav1.Time `json:"created_at"`
	UpdatedAt *metav1.Time `json:"updated_at"`
}

Comment is a comment payload

type CommentBody added in v0.2.0 

type CommentBody struct {
	Body string `json:"body"`
}

CommentBody is a body structure for creating new comment

type CommitStatusBody 

type CommitStatusBody struct {
	State       string `json:"state"`
	TargetURL   string `json:"target_url"`
	Description string `json:"description"`
	Context     string `json:"context"`
}

CommitStatusBody is an API body for setting commits' status

type IssueCommentWebhook added in v0.2.0 

type IssueCommentWebhook struct {
	Action  string  `json:"action"`
	Comment Comment `json:"comment"`
	Issue   struct {
		PullRequest struct {
			URL string `json:"url"`
		} `json:"pull_request"`
	} `json:"issue"`
	Repo   Repo `json:"repository"`
	Sender User `json:"sender"`
}

IssueCommentWebhook is a github-specific issue_comment webhook body

type PullRequest added in v0.2.0 

type PullRequest struct {
	Title  string `json:"title"`
	Number int    `json:"number"`
	State  string `json:"state"`
	URL    string `json:"html_url"`
	User   User   `json:"user"`
	Head   struct {
		Ref string `json:"ref"`
		Sha string `json:"sha"`
	} `json:"head"`
	Base struct {
		Ref string `json:"ref"`
	} `json:"base"`
}

PullRequest is a pull request info

type PullRequestReviewCommentWebhook added in v0.2.0 

type PullRequestReviewCommentWebhook struct {
	Action      string      `json:"action"`
	Comment     Comment     `json:"comment"`
	PullRequest PullRequest `json:"pull_request"`
	Repo        Repo        `json:"repository"`
	Sender      User        `json:"sender"`
}

PullRequestReviewCommentWebhook is a github-specific pull_request_review_comment webhook body

type PullRequestReviewWebhook added in v0.2.0 

type PullRequestReviewWebhook struct {
	Action string `json:"action"`
	Review struct {
		Body        string       `json:"body"`
		SubmittedAt *metav1.Time `json:"submitted_at"`
	} `json:"review"`
	PullRequest PullRequest `json:"pull_request"`
	Repo        Repo        `json:"repository"`
	Sender      User        `json:"sender"`
}

PullRequestReviewWebhook is a github-specific pull_request_review webhook body

type PullRequestWebhook 

type PullRequestWebhook struct {
	Action string `json:"action"`
	Number int    `json:"number"`
	Sender User   `json:"sender"`

	PullRequest PullRequest `json:"pull_request"`

	Repo Repo `json:"repository"`
}

PullRequestWebhook is a github-specific pull-request event webhook body

type PushWebhook 

type PushWebhook struct {
	Ref    string `json:"ref"`
	Repo   Repo   `json:"repository"`
	Sender User   `json:"sender"`
	Sha    string `json:"after"`
}

PushWebhook is a github-specific push event webhook body

type RegistrationWebhookBody 

type RegistrationWebhookBody struct {
	Name   string                        `json:"name"`
	Active bool                          `json:"active"`
	Events []string                      `json:"events"`
	Config RegistrationWebhookBodyConfig `json:"config"`
}

RegistrationWebhookBody is a request body for registering webhook to remote git server

type RegistrationWebhookBodyConfig 

type RegistrationWebhookBodyConfig struct {
	URL         string `json:"url"`
	ContentType string `json:"content_type"`
	InsecureSsl string `json:"insecure_ssl"`
	Secret      string `json:"secret"`
}

RegistrationWebhookBodyConfig is a config for the webhook

type Repo 

type Repo struct {
	Name  string `json:"full_name"`
	URL   string `json:"html_url"`
	Owner struct {
		ID string `json:"login"`
	} `json:"owner"`
	Private bool `json:"private"`
}

Repo structure for webhook event

type User added in v0.2.0 

type User struct {
	Name string `json:"login"`
	ID   int    `json:"id"`
}

User is a sender of the event

type UserInfo added in v0.1.4 

type UserInfo struct {
	ID       int    `json:"id"`
	UserName string `json:"login"`
	Email    string `json:"email"`
}

UserInfo is a body of user get API

type UserPermission added in v0.2.0 

type UserPermission struct {
	Permission string `json:"permission"`
}

UserPermission is a user's permission on a repository

type WebhookEntry 

type WebhookEntry struct {
	ID     int `json:"id"`
	Config struct {
		URL string `json:"url"`
	} `json:"config"`
}

WebhookEntry is a body of list of registered webhooks

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.