winch

package module
v1.2.7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 23, 2020 License: GPL-3.0 Imports: 25 Imported by: 0

README

winch

Build

Winch is a universal build and release tool.

Configuration File

Winch reads from a winch.yml in the current directory (optionally from a specified using the -f option on the command line).

name: "string"                          # the name of the project
description: "string"                   # the description of the project
repository: "string"                    # URL to the GitHub repository
local: false                            # set to true to use only the local repository
verbose: false                          # set to true to get verbose output
quiet: false                            # set to true to get quiet output
language: "go"                          # "go" and "node" are the only supported languages currently
toolchain: "string"                     # node projects can choose "npm" or "yarn"
ci:
  enabled: true                         # set to false to disable CI
  branches:
    ignore: "string/regexp"             # execute CI unless the current branch matches the given pattern
    only: "string/regexp"               # execute CI only if the current branch matches the given pattern
  tags:
    ignore: "string/regexp"             # execute CI unless the current tag matches the given pattern
    only: "string/regexp"               # execute CI unless the current tag matches the given pattern
before_install:                         # executed before installation (see commands/"string")
install:                                # executed to install (see commands/"string")
after_install:                          # executed after installation (see commands/"string")
before_build:                           # executed before building (see commands/"string")
build:                                  # executed to build (see commands/"string")
after_build:                            # executed after building (see commands/"string")
before_test:                            # executed before testing (see commands/"string")
test:                                   # executed to test (see commands/"string")
after_test:                             # executed after testing (see commands/"string")
assets:
- enabled: true                         # set to false to disable asset generation
  filename: "string"                    # the filename to generate
  directory: "string"                   # the directory containing the assets
  package: "string"                     # the Go package containing the assets
  variable: "string"                    # the Assets variable to generate
  tag: "string"                         # the build tag to add to the file
  only:
    - "string"                          # only include files matching the given pattern
  except:
    - "string"                          # only include files except those matching the given pattern
  branches:
    ignore: "string/regexp"             # generate assets unless the current branch matches the given pattern
    only: "string/regexp"               # generate assets only if the current branch matches the given pattern
  tags:
    ignore: "string/regexp"             # generate assets unless the current tag matches the given pattern
    only: "string/regexp"               # generate assets unless the current tag matches the given pattern
changelog:
  enabled: true                         # set to false to disable changelog generation
  template: "string"                    # name of a file containing the CHANGELOG template
  file: "string"                        # name of the output file
version:
  enabled: true                         # set to false to disable version generation
  template: "string"                    # name of a file containing the version file template
  file: "string"                        # name of the output file
transom:
  enabled: true                         # set to false to disable transom publication
  server: "string"                      # hostname of the transom server (defaults to transom.b10s.io)
  application: "string"                 # application name defined in transom
  token: "string"                       # authentication token to use
  username: "string"                    # username if token not provided
  password: "string"                    # password if token not provided
  directory: "string"                   # the directory containing assets
  artifacts:
  - "string"                            # artifacts to upload to the Transom bundle
  - "string"
  branches:
    ignore: "string/regexp"             # publish to Transom unless the current branch matches the given pattern
    only: "string/regexp"               # publish to Transom only if the current branch matches the given pattern
  tags:
    ignore: "string/regexp"             # publish to Transom unless the current tag matches the given pattern
    only: "string/regexp"               # publish to Transom unless the current tag matches the given pattern
dockerfile:
  enabled: true                         # set to false to disable Dockerfile generation
  template: "string"                    # name of a file containing the Dockerfile template
  file: "string"                        # name of the output file
docker:
  enabled: true                         # set to false to disable docker image pushing
  organization: "string"                # DockerHub organization
  repository: "string"                  # DockerHub repository
  username: "string"                    # username to login to DockerHub
  password: "string"                    # password to login to DockerHub
  dockerfile: "string"                  # Dockerfile to process (defaults to "Dockerfile")
  context: "string"                     # context directory (defaults to ".")
  tag: "string"                         # tag to use in addition to version (defaults to "latest")
  buildargs:
    "string": value                     # build args to add to the build
  branches:
    ignore: "string/regexp"             # publish to DockerHub unless the current branch matches the given pattern
    only: "string/regexp"               # publish to DockerHub only if the current branch matches the given pattern
  tags:
    ignore: "string/regexp"             # publish to DockerHub unless the current tag matches the given pattern
    only: "string/regexp"               # publish to DockerHub unless the current tag matches the given pattern
dockers:
- @docker                               # same as the docker configuration above
release:
  enabled: true                         # set to false to disable creating GitHub releases
  artifacts:
  - "string"                            # artifacts to add to the GitHub release
  - "string"
  branches:
    ignore: "string/regexp"             # create release unless the current branch matches the given pattern
    only: "string/regexp"               # create release only if the current branch matches the given pattern
  tags:
    ignore: "string/regexp"             # create release unless the current tag matches the given pattern
    only: "string/regexp"               # create release unless the current tag matches the given pattern
database:
  dialect: "string"                     # only "postgres" supported currently
  host: "string"                        # database hostname (defaults to "localhost")
  port: int                             # database port (defaults to 5432)
  database: "string"                    # database name (defaults to postgres)
  username: "string"                    # database username (defaults to postgres)
  password: "string"                    # database password
  dir: "string"                         # data directory (defaults to "data")
  secure: false                         # set to true to connect securely to server
  timestamp: false                      # set to true to create a timestamped database
dynamodb:
  endpoint: "string"                    # endpoint for Dynamo (defaults to "http://localhost:8000/")
  dir: "string"                         # data directory (defaults to "data")
vault:
  address: "string"                     # endpoint for Vault
  token: "string"                       # token to authenticate to Vault
  prefix: "string"                      # root path to start dumping/recreating from
  dir: "string"                         # data directory (defaults to "data")
commands:
  "string":
    enabled: true                       # set to false to disable the command
    name: "string"                      # name of the command
    command: "string"                   # command to execute
    environment:
      "string": value
    branches:
      ignore: "string/regexp"           # execute command unless the current branch matches the given pattern
      only: "string/regexp"             # execute command only if the current branch matches the given pattern
    tags:
      ignore: "string/regexp"           # execute command unless the current tag matches the given pattern
      only: "string/regexp"             # execute command unless the current tag matches the given pattern
    input: "string"                     # string to use as STDIN for the command
environment:
  "string": value                       # environment variables to use for all commands

Global options

Flags:
  -h, --help   help for build

Global Flags:
  -f, --file string   configuration file (default "winch.yml")
  -q, --quiet         quiet output
  -v, --verbose       verbose output

Build

Execute the build command sequence.

$ winch build --help
Build

Usage:
  winch build [flags]

CI

Execute a CI build command sequence:

  1. Create version file
  2. Create CHANGELOG file
  3. Install
  4. Build
  5. Test
  6. Release
  7. Publish to Transom
  8. Publish to Docker
# winch ci --help
Execute a CI build

Usage:
  winch ci [flags]

Create Database

Create a database.

$ winch db create --help
Create the database

Usage:
  winch db create [flags]

Flags:
      --database string   database name (default "postgres")
      --dialect string    database dialect (default "postgres")
      --dir string        output directory (default "./data")
      --host string       database host (default "localhost")
      --password string   database password
      --port int          database port (default 5432)
      --secure            database secure connection
      --timestamp         create a timestamped database
      --username string   database username (default "postgres")

Drop Database

Drop the database.

$ winch db drop --help
Drop the database

Usage:
  winch db drop [flags]

Flags:
      --database string   database name (default "postgres")
      --dialect string    database dialect (default "postgres")
      --host string       database host (default "localhost")
      --password string   database password
      --port int          database port (default 5432)
      --secure            database secure connection
      --username string   database username (default "postgres")

Dump Database

Dump the database.

$ winch db dump --help
Dump the database

Usage:
  winch db dump [flags]

Flags:
      --database string   database name (default "postgres")
      --dialect string    database dialect (default "postgres")
      --dir string        output directory (default "./data")
      --host string       database host (default "localhost")
      --password string   database password
      --port int          database port (default 5432)
      --secure            database secure connection
      --username string   database username (default "postgres")

Recreate Database

Recreate a database.

$ winch db recreate --help
Recreate the database

Usage:
  winch db recreate [flags]

Flags:
      --database string   database name (default "postgres")
      --dialect string    database dialect (default "postgres")
      --dir string        output directory (default "./data")
      --host string       database host (default "localhost")
      --password string   database password
      --port int          database port (default 5432)
      --secure            database secure connection
      --timestamp         create a timestamped database
      --update            update connection settings in application config
      --username string   database username (default "postgres")

Create Dynamodb Database

$ winch dynamodb create --help
Create the database

Usage:
  winch dynamodb create [flags]

Flags:
      --dir string                 data directory (default "./data/dynamodb")
      --dynamodb.endpoint string   Dynamodb endpoint

Drop Dynamodb Database

$ winch dynamodb drop --help
Drop the database

Usage:
  winch dynamodb drop [flags]

Flags:
      --dynamodb.endpoint string   Dynamodb endpoint

Dump Dynamodb Database

$ winch dynamodb dump --help
Dump the database

Usage:
  winch dynamodb dump [flags]

Flags:
      --dynamodb.dir string        data directory (default "./data/dynamodb")
      --dynamodb.endpoint string   Dynamodb endpoint

Recreate Dynamodb Database

$ winch dynamodb recreate --help
Recreate the database

Usage:
  winch dynamodb recreate [flags]

Flags:
      --dir string                 data directory (default "./data/dynamodb")
      --dynamodb.endpoint string   Dynamodb endpoint

Create Vault Database

$ winch vault create --help
Create the database

Usage:
  winch vault create [flags]

Drop Vault Database

$ winch vault drop --help
Drop the database

Usage:
  winch vault drop [flags]

Dump Vault Database

$ winch vault dump --help
Dump the database

Usage:
  winch vault dump [flags]

Recreate Vault Database

$ winch vault recreate --help
Recreate the database

Usage:
  winch vault recreate [flags]

Docker Build

Build a Docker image.

$ winch docker build --help
Build docker image

Usage:
  winch docker build [flags]

Docker Publish

Push an image to DockerHub.

$ winch docker publish --help
Publish container to DockerHub

Usage:
  winch docker publish [flags]

Generate Changelog

Generate a CHANGELOG file.

$ winch generate changelog --help
Generate a changelog

Usage:
  winch generate changelog [flags]

Flags:
  -o, --output string   output file

Generate Version

Generate a version file (or update version information).

$ winch generate version --help
Generate the version file

Usage:
  winch generate version [flags]

Flags:
  -o, --output string   output file

Init

Initialize the current directory to use winch, creating a winch.yml.

$ winch init --help
Initialize a configuration file

Usage:
  winch init [flags]

Install

Run the install command sequence.

$ winch install --help
Install

Usage:
  winch install [flags]

Name

Generate a new release name.

$ winch name --help
Generate a release name

Usage:
  winch name [flags]

Release

Create a GitHub release and upload artifacts. The GitHub release description includes a description of the changes from the previous release.

$ winch release --help
Release changes

Usage:
  winch release [flags]

Run

Run the specified command.

$ winch run --help
Run a command

Usage:
  winch run COMMAND [flags]

Test

Run the test command sequence.

$ winch test --help
Test

Usage:
  winch test [flags]

Transom Publish

Publish the artifacts to transom.

$ winch transom publish --help
Publish artifacts to Transom

Usage:
  winch transom publish [flags]

Version

Output the version.

$ winch version --help
Show the version

Usage:
  winch version [flags]

LICENSE

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var WordLists = make(map[string][]string)

Functions

func CheckFilter 

func CheckFilter(ctx context.Context, filter *config.FilterConfig, in string) bool

func CheckFilters 

func CheckFilters(ctx context.Context, branches *config.FilterConfig, tags *config.FilterConfig) bool

func FindGitDir 

func FindGitDir(_ context.Context) string

func Name 

func Name(_ context.Context, segments ...string) string

func Psql 

func Psql(cfg *config.Config, path string, database string) error

func Run 

func Run(ctx context.Context, cmd *config.RunConfig, cfg *config.Config) error

func TagCommits 

func TagCommits(_ context.Context, commits []*Commit, tags map[string]string)

Types

type Branch 

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

func (Branch) GetName 

func (b Branch) GetName() string

func (Branch) IsBranch 

func (b Branch) IsBranch() bool

func (Branch) IsTag 

func (b Branch) IsTag() bool

type Changelog 

type Changelog struct {
	Repository string
	Releases   []*ChangelogRelease
}

func MakeChangelog 

func MakeChangelog(_ context.Context, repository string, releases []*Release) (*Changelog, error)

type ChangelogRelease 

type ChangelogRelease struct {
	Version         string
	PreviousVersion string
	Date            string
	Timestamp       time.Time
	Sections        []*ReleaseSection
	FirstCommitHash string
	LastCommitHash  string
	IsNew           bool
}

type CircleCI 

type CircleCI struct{}

func (CircleCI) GetHead 

func (c CircleCI) GetHead(_ context.Context) (GitRef, error)

type Commit 

type Commit struct {
	Hash         string
	PreviousHash string
	NextHash     string
	When         time.Time
	Message      *Message
	Tag          string
}

func (Commit) ShortHash 

func (c Commit) ShortHash() string

func (Commit) Title 

func (c Commit) Title() string

type CommitType 

type CommitType string

func GetCommitTypes 

func GetCommitTypes() []CommitType

func NewType 

func NewType(s string) CommitType

func (CommitType) Description 

func (t CommitType) Description() string

func (CommitType) IsMinor 

func (t CommitType) IsMinor() bool

func (CommitType) IsPatch 

func (t CommitType) IsPatch() bool

func (CommitType) String 

func (t CommitType) String() string

func (CommitType) Title 

func (t CommitType) Title() string

type Git 

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

func NewGit 

func NewGit(_ context.Context, dir string) (*Git, error)

func (Git) GetCommits 

func (g Git) GetCommits(_ context.Context) ([]*Commit, error)

func (Git) GetHead 

func (g Git) GetHead(_ context.Context) (GitRef, error)

func (Git) GetTags 

func (g Git) GetTags(_ context.Context) (map[string]string, error)

type GitHub 

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

func NewGitHub 

func NewGitHub(ctx context.Context, url string) (*GitHub, error)

func (GitHub) CreateRelease 

func (g GitHub) CreateRelease(ctx context.Context, tag string, body string) (*github.RepositoryRelease, error)

func (GitHub) GetCommits 

func (g GitHub) GetCommits(ctx context.Context) ([]*Commit, error)

func (GitHub) GetTags 

func (g GitHub) GetTags(ctx context.Context) (map[string]string, error)

func (GitHub) UploadAsset 

func (g GitHub) UploadAsset(ctx context.Context, relID int64, artifact string) error

type GitRef 

type GitRef interface {
	GetName() string
	IsBranch() bool
	IsTag() bool
}

type GoMod 

type GoMod struct {
	Module  Module    `json:"module"`
	Go      string    `json:"go"`
	Require []Require `json:"require"`
	Exclude []Module  `json:"exclude"`
	Replace []Replace `json:"replace"`
}

func LoadGoModuleDefinition 

func LoadGoModuleDefinition(ctx context.Context, dir string) (*GoMod, error)

LoadGoModuleDefinition loads the go.mod definition in a given directory

type Message 

type Message struct {
	Type            CommitType
	IsBreaking      bool
	Scope           string
	Subject         string
	Body            string
	BreakingMessage string
}

func ParseMessage 

func ParseMessage(message string) *Message

func (Message) ScopePrefix 

func (m Message) ScopePrefix() string

func (Message) Title 

func (m Message) Title() string

type Module 

type Module struct {
	Path    string `json:"path"`
	Version string `json:"version"`
}

type Release 

type Release struct {
	Version         string
	PreviousVersion string
	Date            time.Time
	Commits         map[CommitType][]*Commit
	FirstCommitHash string
	LastCommitHash  string
	IsNew           bool
}

func MakeReleases 

func MakeReleases(_ context.Context, commits []*Commit, makeRelease bool) ([]*Release, error)

type ReleaseSection 

type ReleaseSection struct {
	Title      string
	IsBreaking bool
	Commits    []*Commit
}

type Replace 

type Replace struct {
	Old Module `json:"old"`
	New Module `json:"new"`
}

type Repository 

type Repository interface {
	GetTags(ctx context.Context) (map[string]string, error)
	GetCommits(ctx context.Context) ([]*Commit, error)
}

type Require 

type Require struct {
	Path     string `json:"path"`
	Version  string `json:"version"`
	Indirect bool   `json:"indirect"`
}

type Tag 

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

func (Tag) GetName 

func (b Tag) GetName() string

func (Tag) IsBranch 

func (b Tag) IsBranch() bool

func (Tag) IsTag 

func (b Tag) IsTag() bool

Source Files

View all Source files

Directories

Path Synopsis
cmd
winch
winch/commands
Code generated by winch.
 Code generated by winch.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.