review

Documentation

Overview

Licensed to Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. Apache Software Foundation (ASF) licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Variables
• func GetAllReviewsComments() []*github.PullRequestComment
• func GetChangedFiles() []*github.CommitFile
• func GetSha() (string, error)
• func Header(result *header2.Result, config *config2.Config) error
• func IsGHA() bool
• func IsPR() bool
• func Markdown(result *header2.Result) string
• type Event

Variables

var (
	Identification = "license-eye hidden identification"
)

Functions

func GetAllReviewsComments

func GetAllReviewsComments() []*github.PullRequestComment

GetAllReviewsComments returns all review comments of the pull request.

func GetChangedFiles

func GetChangedFiles() []*github.CommitFile

GetChangedFiles returns the changed files in this pull request.

func GetSha

func GetSha() (string, error)

func Header

func Header(result *header2.Result, config *config2.Config) error

Header reviews the license header, including suggestions on the pull request and an overview of the checks.

func IsGHA

func IsGHA() bool

func IsPR

func IsPR() bool

func Markdown

func Markdown(result *header2.Result) string

TODO add fixing guide

Types

type Event

type Event struct {
	PR github.PullRequest `json:"pull_request"`
}