cmd

Documentation

Overview

Copyright © 2021 LUKASZ RACZYLO <lukasz$raczylo,com>

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.

Copyright © 2021 LUKASZ RACZYLO <lukasz$raczylo,com>

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

• Variables
• func Execute()
• type CommitDetails
• type Force
• type SemVer
• type Setup
  • func (s *Setup) CalculateSemver() SemVer
  • func (s *Setup) ForcedVersioning()
  • func (s *Setup) ListCommits() ([]CommitDetails, error)
  • func (s *Setup) ListExistingTags()
  • func (s *Setup) Prepare() error
  • func (s *Setup) ReadConfig(file string) error
• type TagDetails
• type Wording

Variables

var (
	PKG_VERSION string
)

Functions

func Execute

func Execute()

Types

type CommitDetails

type CommitDetails struct {
	Hash      string
	Author    string
	Message   string
	Timestamp time.Time
}

type Force

type Force struct {
	Patch    int
	Minor    int
	Major    int
	Commit   string
	Existing bool
}

type SemVer

type SemVer struct {
	Patch                  int
	Minor                  int
	Major                  int
	Release                int
	EnableReleaseCandidate bool
}

type Setup

type Setup struct {
	RepositoryName      string
	RepositoryLocalPath string
	RepositoryHandler   *git.Repository
	Commits             []CommitDetails
	Tags                []TagDetails
	Semver              SemVer
	Wording             Wording
	Force               Force
	Generate            bool
	LocalConfigFile     string
	UseLocal            bool
}

func (*Setup) CalculateSemver

func (s *Setup) CalculateSemver() SemVer

func (*Setup) ForcedVersioning

func (s *Setup) ForcedVersioning()

func (*Setup) ListCommits

func (s *Setup) ListCommits() ([]CommitDetails, error)

func (*Setup) ListExistingTags

func (s *Setup) ListExistingTags()

func (*Setup) Prepare

func (s *Setup) Prepare() error

func (*Setup) ReadConfig

func (s *Setup) ReadConfig(file string) error

type TagDetails

type TagDetails struct {
	Name string
	Hash string
}

type Wording

type Wording struct {
	Patch   []string
	Minor   []string
	Major   []string
	Release []string
}