github

Documentation

Overview

* © 2023 Snyk Limited * * 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

• type Artifact
• type RepositoryClient
  • func New(ctx context.Context, tok, repoOwner, repoName string) RepositoryClient
  • func (rc *RepositoryClient) RepoURL() string
  • func (rc *RepositoryClient) UploadToRelease(ctx context.Context, releaseTag string, artifact Artifact) (url string, err error)

Types

type Artifact

type Artifact interface {
	OpenFile() (*os.File, error)
}

An Artifact has a Name and is backed by a File.

type RepositoryClient

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

func New

func New(ctx context.Context, tok, repoOwner, repoName string) RepositoryClient

func (*RepositoryClient) RepoURL

func (rc *RepositoryClient) RepoURL() string

RepoURL returns the repository URL for this client.

func (*RepositoryClient) UploadToRelease

func (rc *RepositoryClient) UploadToRelease(ctx context.Context, releaseTag string, artifact Artifact) (url string, err error)

UploadToRelease uploads the given artifact to a release with the given releaseTag. Returns the URL from which the artifact can be downloaded.