releases

Documentation

Index

• func IsNil(i interface{}) bool
• type CreateReleaseResponseV1
• type CreateReleaseV1
  • func NewCreateReleaseV1(spaceNameOrID string, projectNameOrID string) *CreateReleaseV1
  • func (c *CreateReleaseV1) MarshalJSON() ([]byte, error)
• type ICreateReleaseV1
• type Progression
• type Release
  • func NewRelease(channelID string, projectID string, version string) *Release
• type ReleaseChanges
• type ReleasePackageVersionBuildInformation
• type ReleaseProgression
• type ReleaseQuery
• type ReleaseService
  • func NewReleaseService(sling *sling.Sling, uriTemplate string) *ReleaseService
  • func (s *ReleaseService) Add(release *Release) (*Release, error)
  • func (s *ReleaseService) CreateV1(createReleaseV1 *CreateReleaseV1) (*CreateReleaseResponseV1, error)
  • func (s *ReleaseService) Get(releasesQuery ...ReleasesQuery) (*resources.Resources[*Release], error)
  • func (s *ReleaseService) GetByID(id string) (*Release, error)
  • func (s *ReleaseService) GetReleases(channel *channels.Channel, releaseQuery ...*ReleaseQuery) (*resources.Resources[*Release], error)
• type ReleaseTemplatePackage
• type ReleaseUsage
• type ReleaseUsageEntry
• type ReleasesQuery

Functions

func IsNil

func IsNil(i interface{}) bool

Types

type CreateReleaseResponseV1

type CreateReleaseResponseV1 struct {
	ReleaseID                         string `json:"ReleaseId"`
	ReleaseVersion                    string `json:"ReleaseVersion"`
	AutomaticallyDeployedEnvironments string `json:"AutomaticallyDeployedEnvironments,omitempty"`
}

type CreateReleaseV1

type CreateReleaseV1 struct {
	ChannelNameOrID       string   `json:"channelIdOrName,omitempty"`
	IgnoreChannelRules    bool     `json:"ignoreChannelRules,omitempty"`
	IgnoreIfAlreadyExists bool     `json:"ignoreIfAlreadyExists,omitempty"`
	GitCommit             string   `json:"gitCommit,omitempty"`
	GitRef                string   `json:"gitRef,omitempty"`
	SpaceNameOrID         string   `json:"spaceIdOrName"`
	PackagePrerelease     string   `json:"packagePrerelease,omitempty"`
	Packages              []string `json:"packages,omitempty"`
	PackageVersion        string   `json:"packageVersion,omitempty"`
	ProjectNameOrID       string   `json:"projectName"`
	ReleaseVersion        string   `json:"releaseVersion,omitempty"`
	ReleaseNotes          string   `json:"releaseNotes,omitempty"`
}

func NewCreateReleaseV1

func NewCreateReleaseV1(spaceNameOrID string, projectNameOrID string) *CreateReleaseV1

func (*CreateReleaseV1) MarshalJSON

func (c *CreateReleaseV1) MarshalJSON() ([]byte, error)

MarshalJSON returns create-release resource (V1) as its JSON encoding.

type ICreateReleaseV1

type ICreateReleaseV1 interface {
}

type Progression

type Progression struct {
	ChannelEnvironments map[string][]resources.ReferenceDataItem `json:"ChannelEnvironments,omitempty"`
	Environments        []*resources.ReferenceDataItem           `json:"Environments"`
	Releases            []*ReleaseProgression                    `json:"Releases"`

	resources.Resource
}

type Release

type Release struct {
	Assembled                          time.Time                                `json:"Assembled,omitempty"`
	BuildInformation                   []*ReleasePackageVersionBuildInformation `json:"BuildInformation,omitempty"`
	ChannelID                          string                                   `json:"ChannelId,omitempty"`
	IgnoreChannelRules                 bool                                     `json:"IgnoreChannelRules,omitempty"`
	LibraryVariableSetSnapshotIDs      []string                                 `json:"LibraryVariableSetSnapshotIds,omitempty"`
	ProjectDeploymentProcessSnapshotID string                                   `json:"ProjectDeploymentProcessSnapshotId,omitempty"`
	ProjectID                          string                                   `json:"ProjectId,omitempty"`
	ProjectVariableSetSnapshotID       string                                   `json:"ProjectVariableSetSnapshotId,omitempty"`
	ReleaseNotes                       string                                   `json:"ReleaseNotes,omitempty"`
	SelectedPackages                   []*packages.SelectedPackage              `json:"SelectedPackages,omitempty"`
	SpaceID                            string                                   `json:"SpaceId,omitempty"`
	Version                            string                                   `json:"Version"`

	resources.Resource
}

func NewRelease

func NewRelease(channelID string, projectID string, version string) *Release

type ReleaseChanges

type ReleaseChanges struct {
	BuildInformation []*ReleasePackageVersionBuildInformation `json:"BuildInformation"`
	Commits          []*core.CommitDetails                    `json:"Commits"`
	ReleaseNotes     string                                   `json:"ReleaseNotes,omitempty"`
	Version          string                                   `json:"Version,omitempty"`
	WorkItems        []*core.WorkItemLink                     `json:"WorkItems"`
}

type ReleasePackageVersionBuildInformation

type ReleasePackageVersionBuildInformation struct {
	Branch           string                `json:"Branch,omitempty"`
	BuildEnvironment string                `json:"BuildEnvironment,omitempty"`
	BuildNumber      string                `json:"BuildNumber,omitempty"`
	BuildURL         string                `json:"BuildUrl,omitempty"`
	Commits          []*core.CommitDetails `json:"Commits"`
	PackageID        string                `json:"PackageId,omitempty"`
	VcsCommitNumber  string                `json:"VcsCommitNumber,omitempty"`
	VcsCommitURL     string                `json:"VcsCommitUrl,omitempty"`
	VcsRoot          string                `json:"VcsRoot,omitempty"`
	VcsType          string                `json:"VcsType,omitempty"`
	Version          string                `json:"Version,omitempty"`
	WorkItems        []*core.WorkItemLink  `json:"WorkItems"`
}

type ReleaseProgression

type ReleaseProgression struct {
	Channel                 *channels.Channel                    `json:"Channel,omitempty"`
	Deployments             map[string][]dashboard.DashboardItem `json:"Deployments,omitempty"`
	HasUnresolvedDefect     bool                                 `json:"HasUnresolvedDefect,omitempty"`
	NextDeployments         []string                             `json:"NextDeployments"`
	Release                 *Release                             `json:"Release,omitempty"`
	ReleaseRetentionPeriod  *core.RetentionPeriod                `json:"ReleaseRetentionPeriod,omitempty"`
	TentacleRetentionPeriod *core.RetentionPeriod                `json:"TentacleRetentionPeriod,omitempty"`
}

type ReleaseQuery

type ReleaseQuery struct {
	SearchByVersion string `uri:"searchByVersion" url:"searchByVersion,omitempty"`
	Skip            int    `uri:"skip,omitempty" url:"skip,omitempty"`
	Take            int    `uri:"take,omitempty" url:"take,omitempty"`
}

type ReleaseService

type ReleaseService struct {
	services.CanDeleteService
}

func NewReleaseService

func NewReleaseService(sling *sling.Sling, uriTemplate string) *ReleaseService

func (*ReleaseService) Add

func (s *ReleaseService) Add(release *Release) (*Release, error)

Add creates a new release.

func (*ReleaseService) CreateV1

func (s *ReleaseService) CreateV1(createReleaseV1 *CreateReleaseV1) (*CreateReleaseResponseV1, error)

func (*ReleaseService) Get

func (s *ReleaseService) Get(releasesQuery ...ReleasesQuery) (*resources.Resources[*Release], error)

Get returns a collection of releases based on the criteria defined by its input query parameter. If an error occurs, an empty collection is returned along with the associated error.

func (*ReleaseService) GetByID

func (s *ReleaseService) GetByID(id string) (*Release, error)

GetByID returns the release that matches the input ID. If one cannot be found, it returns nil and an error.

func (*ReleaseService) GetReleases

func (s *ReleaseService) GetReleases(channel *channels.Channel, releaseQuery ...*ReleaseQuery) (*resources.Resources[*Release], error)

type ReleaseTemplatePackage

type ReleaseTemplatePackage struct {
	ActionName                 string `json:"ActionName,omitempty"`
	FeedID                     string `json:"FeedId,omitempty"`
	FeedName                   string `json:"FeedName,omitempty"`
	IsResolvable               bool   `json:"IsResolvable,omitempty"`
	NuGetFeedID                string `json:"NuGetFeedId,omitempty"`
	NuGetFeedName              string `json:"NuGetFeedName,omitempty"`
	NuGetPackageID             string `json:"NuGetPackageId,omitempty"`
	PackageID                  string `json:"PackageId,omitempty"`
	PackageReferenceName       string `json:"PackageReferenceName,omitempty"`
	ProjectName                string `json:"ProjectName,omitempty"`
	StepName                   string `json:"StepName,omitempty"`
	VersionSelectedLastRelease string `json:"VersionSelectedLastRelease,omitempty"`
}

type ReleaseUsage

type ReleaseUsage struct {
	ProjectID   string               `json:"ProjectId,omitempty"`
	ProjectName string               `json:"ProjectName,omitempty"`
	Releases    []*ReleaseUsageEntry `json:"Releases"`
}

type ReleaseUsageEntry

type ReleaseUsageEntry struct {
	ReleaseID      string `json:"ReleaseId,omitempty"`
	ReleaseVersion string `json:"ReleaseVersion,omitempty"`
}

type ReleasesQuery

type ReleasesQuery struct {
	IDs                []string `uri:"ids,omitempty" url:"ids,omitempty"`
	IgnoreChannelRules bool     `uri:"ignoreChannelRules,omitempty" url:"ignoreChannelRules,omitempty"`
	Skip               int      `uri:"skip,omitempty" url:"skip,omitempty"`
	Take               int      `uri:"take,omitempty" url:"take,omitempty"`
}