Documentation
¶
Overview ¶
Package releases implements functions for interacting with 'Releases' provided by VCS providers. The Release terminology largely comes from Github and can be thought of as versioned artifacts that correspond to a Git tag.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Fetch ¶
func Fetch(ctx context.Context, opts *FetchOptions) (io.ReadCloser, fs.FileInfo, error)
Fetch fetches a release from a VCS provider and returns an asset from it as an io.ReadCloser. This must be closed to close the underlying HTTP request.
func GetReleaseNotes ¶
func GetReleaseNotes(ctx context.Context, opts *GetReleaseNoteOptions) (string, error)
GetReleaseNotes fetches the release notes of a release from a VCS provider.
Types ¶
type Client ¶
type Client struct{}
Client contains configuration for fetching releases from various VCS providers.
type FetchOptions ¶
type FetchOptions = opts.FetchOptions
FetchOptions is an alias for opts.FetchOptions.
type GetReleaseNoteOptions ¶
type GetReleaseNoteOptions = opts.GetReleaseNoteOptions
GetReleaseNoteOptions is an alias for opts.GetReleaseNoteOptions.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package github implements [opts.Fetcher] for Github releases.
|
Package github implements [opts.Fetcher] for Github releases. |
|
Package gitlab implements [opts.Fetcher] for Gitlab releases.
|
Package gitlab implements [opts.Fetcher] for Gitlab releases. |
|
internal
|
|
|
opts
Package opts contains the options and interfaces for the releases package.
|
Package opts contains the options and interfaces for the releases package. |
Click to show internal directories.
Click to hide internal directories.