ci

Documentation

Overview

SPDX-License-Identifier: Apache-2.0

Copyright © 2023 The listen.dev team <engineering@garnet.ai>

Licensed 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.

SPDX-License-Identifier: Apache-2.0

Copyright © 2023 The listen.dev team <engineering@garnet.ai>

Licensed 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

• func IsRunningInGitHubAction() bool
• type Dumper
• type GitHubEvent
  • func NewGitHubEventFromPath(eventPath string) (*GitHubEvent, error)
• type Info
  • func NewInfo() (*Info, error)
  • func NewInfoFromGitHub() (*Info, error)
  • func NewInfoFromGitHubEvent() (*Info, error)
  • func (i *Info) Dump() string
  • func (i *Info) HasReadOnlyGitHubToken() bool
  • func (i *Info) IsGitHubPullRequest() bool

Functions

func IsRunningInGitHubAction

func IsRunningInGitHubAction() bool

IsRunningInGitHubAction tells whether the current process is running in GitHub actions or not.

See https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables.

Types

type Dumper

type Dumper interface {
	Dump() string
}

type GitHubEvent

type GitHubEvent struct {
	Repo        github.PushEventRepository `json:"repository"`
	HeadCommit  github.HeadCommit          `json:"head_commit"`
	PullRequest github.PullRequest         `json:"pull_request"`
	CheckSuite  github.CheckSuite          `json:"check_suite"`
	Name        string                     `json:"-"` // From GITHUB_EVENT_NAME env var
}

func NewGitHubEventFromPath

func NewGitHubEventFromPath(eventPath string) (*GitHubEvent, error)

NewGitHubEventFromPath creates a GitHubEvent by reading the GITHUB_EVENT_PATH file.

type Info

type Info struct {
	Owner            string
	Repo             string
	SHA              string `dump:"GITHUB_SHA"`
	Num              int    // Pull (merge) request number
	Branch           string // Pull (merge) request branch
	Fork             bool
	Action           string `env:"GITHUB_ACTION"`
	ActionPath       string `env:"GITHUB_ACTION_PATH"`
	ActionRepository string `env:"GITHUB_ACTION_REPOSITORY"`
	Actor            string `env:"GITHUB_ACTOR"`
	ActorID          int64  `env:"GITHUB_ACTOR_ID"`
	EventName        string `dump:"GITHUB_EVENT_NAME"`
	Job              string `env:"GITHUB_JOB"`
	Ref              string `env:"GITHUB_REF"`
	RefName          string `env:"GITHUB_REF_NAME"`
	RefProtected     bool   `env:"GITHUB_REF_PROTECTED"`
	RefType          string `env:"GITHUB_REF_TYPE"`
	RepoFullName     string `env:"GITHUB_REPOSITORY"`
	RepoID           int64  `env:"GITHUB_REPOSITORY_ID"`
	RepoOwner        string `env:"GITHUB_REPOSITORY_OWNER"`
	RepoOwnerID      int64  `env:"GITHUB_REPOSITORY_OWNER_ID"`
	RunAttempt       int64  `env:"GITHUB_RUN_ATTEMPT"`
	RunID            int64  `env:"GITHUB_RUN_ID"`
	RunNumber        int64  `env:"GITHUB_RUN_NUMBER"`
	RunnerArch       string `env:"RUNNER_ARCH"`
	RunnerDebug      bool   `env:"RUNNER_DEBUG"`
	RunnerOs         string `env:"RUNNER_OS"`
	SeverURL         string `env:"GITHUB_SERVER_URL"`
	TriggeringActor  string `env:"GITHUB_TRIGGERING_ACTOR"`
	Workflow         string `env:"GITHUB_WORKFLOW"`
	WorkflowRef      string `env:"GITHUB_WORKFLOW_REF"`
	WorkflowSha      string `env:"GITHUB_WORKFLOW_SHA"`
	Workspace        string `env:"GITHUB_WORKSPACE"`
}

func NewInfo

func NewInfo() (*Info, error)

NewInfo creates a Info from environment variables.

func NewInfoFromGitHub

func NewInfoFromGitHub() (*Info, error)

func NewInfoFromGitHubEvent

func NewInfoFromGitHubEvent() (*Info, error)

NewInfoFromGitHubEvent creates an Info instance using the the file on the GitHub action runner that contains the full event webhook payload.

See https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables.

func (*Info) Dump

func (i *Info) Dump() string

func (*Info) HasReadOnlyGitHubToken

func (i *Info) HasReadOnlyGitHubToken() bool

HasReadOnlyGitHubToken tells whether the current process is running in GitHub Actions on a GitHub PullRequest sent from a fork, with a read-only token.

See https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_target.

func (*Info) IsGitHubPullRequest

func (i *Info) IsGitHubPullRequest() bool