values

Documentation

Index

• Constants
• Variables
• func AddNextReleaseBranch() ([]byte, error)
• func GetChangelogFileName(rt ReleaseTag) string
• func GetChangelogPRs(releaseVersion string, overrideNumber int) (string, error)
• func GetComponentsFromReleaseManifest(releaseManifestURL string) (string, error)
• func GetGitRootDirectory() string
• func GetGitTag(projectOrg, projectName, releaseBranch string) ([]byte, error)
• func GetLatestSupportedReleaseBranch() ([]byte, error)
• func GetSupportedReleaseBranches() ([][]byte, error)
• func GetSupportedReleaseBranchesStrings() ([]string, error)
• func IsDefaultReleaseBranch(providedReleaseBranch string) (bool, error)
• func IsSupportedReleaseBranch(rb string) (bool, error)
• func PRsSinceLastRelease(prs *github.IssuesSearchResult, sectionName string) string
• type AbsolutePath
  • func GetLocalNumber(branch string, ct changetype.ChangeType) (num string, numPath AbsolutePath, err error)
  • func GetReleaseBranchDocsDirectory(pv PathValues) AbsolutePath
  • func GetReleaseDocsDirectory(pv PathValues) AbsolutePath
  • func (ap AbsolutePath) String() string
  • func (ap AbsolutePath) StripRootDirectory() string
• type NewDirectory
  • func MakeNewDirectory(ap AbsolutePath) (*NewDirectory, error)
  • func (nd *NewDirectory) RemoveNewDirectory() error
  • func (nd *NewDirectory) String() string
  • func (nd *NewDirectory) StripRootDirectory() string
• type PathValues
• type ReleaseTag

Constants

const (
	IndexFileName               = "index.md"
	ReleaseAnnouncementFileName = "release-announcement.txt"
)

Variables

var (
	IndexPath  = getAbsolutePath("docs", "contents", IndexFileName)
	ReadmePath = getAbsolutePath("README.md")
)

Functions

func AddNextReleaseBranch

func AddNextReleaseBranch() ([]byte, error)

AddNextReleaseBranch Returns added release branch if no error adding it to file

func GetChangelogFileName

func GetChangelogFileName(rt ReleaseTag) string

func GetChangelogPRs

func GetChangelogPRs(releaseVersion string, overrideNumber int) (string, error)

func GetComponentsFromReleaseManifest

func GetComponentsFromReleaseManifest(releaseManifestURL string) (string, error)

func GetGitRootDirectory

func GetGitRootDirectory() string

GetGitRootDirectory returns path to the project's root. There is no trailing "/". Example: /Users/lovelace/go/eks-distro

func GetGitTag

func GetGitTag(projectOrg, projectName, releaseBranch string) ([]byte, error)

func GetLatestSupportedReleaseBranch

func GetLatestSupportedReleaseBranch() ([]byte, error)

func GetSupportedReleaseBranches

func GetSupportedReleaseBranches() ([][]byte, error)

func GetSupportedReleaseBranchesStrings

func GetSupportedReleaseBranchesStrings() ([]string, error)

func IsDefaultReleaseBranch

func IsDefaultReleaseBranch(providedReleaseBranch string) (bool, error)

func IsSupportedReleaseBranch

func IsSupportedReleaseBranch(rb string) (bool, error)

func PRsSinceLastRelease

func PRsSinceLastRelease(prs *github.IssuesSearchResult, sectionName string) string

Types

type AbsolutePath

type AbsolutePath string

func GetLocalNumber

func GetLocalNumber(branch string, ct changetype.ChangeType) (num string, numPath AbsolutePath, err error)

GetLocalNumber returns the current number and the filepath to the local file used to determine that number for the provided branch and ct. The returned num only reflects the local environment and may not match the upstream source's current number for the branch or ct. Pulling down upstream changes before using this function is highly recommended. Provided branch must exist, the provided ct must be Dev or Prod, and the release number file must exist in the expected location (e.g., /Users/lovelace/go/eks-distro/release/1-24/development/RELEASE)

func GetReleaseBranchDocsDirectory

func GetReleaseBranchDocsDirectory(pv PathValues) AbsolutePath

GetReleaseBranchDocsDirectory returns the expected and absolute filepath for the release branch directory for the provided PathValues. There is no guarantee this directory actually exists. The filepath is simply where it should exist. Example: ~/go/eks-distro/docs/contents/releases/1-24

func GetReleaseDocsDirectory

func GetReleaseDocsDirectory(pv PathValues) AbsolutePath

GetReleaseDocsDirectory returns the expected and absolute filepath for the release doc directory for the provided PathValues. There is no guarantee this directory actually exists. The filepath is simply where it should exist. Example: ~/go/eks-distro/docs/contents/releases/1-24/1

func (AbsolutePath) String

func (ap AbsolutePath) String() string

func (AbsolutePath) StripRootDirectory

func (ap AbsolutePath) StripRootDirectory() string

StripRootDirectory returns the absolute file path with the root directory path removed.

type NewDirectory

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

NewDirectory should not be created directly and instead should only be generated by calling MakeNewDirectory.

func MakeNewDirectory

func MakeNewDirectory(ap AbsolutePath) (*NewDirectory, error)

MakeNewDirectory creates a new directory at provided ap. The provided ap cannot be a path to an existing directory.

func (*NewDirectory) RemoveNewDirectory

func (nd *NewDirectory) RemoveNewDirectory() error

RemoveNewDirectory delete the directory and the associated path value in nd.

func (*NewDirectory) String

func (nd *NewDirectory) String() string

String returns the absolute path value as a string.

func (*NewDirectory) StripRootDirectory

func (nd *NewDirectory) StripRootDirectory() string

StripRootDirectory returns the absolute filepath with the root directory path removed.

type PathValues

type PathValues interface {
	Branch() string
	Number() string
}

type ReleaseTag

type ReleaseTag interface {
	Tag() string
}