Skip to content

Commit

Permalink
chore: Configure github releases, generate install script (#5)
Browse files Browse the repository at this point in the history
  • Loading branch information
cszatmary committed Dec 22, 2020
1 parent d76fc2a commit f3905d4
Show file tree
Hide file tree
Showing 5 changed files with 425 additions and 17 deletions.
20 changes: 6 additions & 14 deletions .goreleaser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,20 +32,19 @@ archives:
- LICENSE
- completions/*

checksum:
name_template: 'checksums.txt'

snapshot:
name_template: "{{ .Tag }}-next"

changelog:
sort: asc
filters:
exclude:
- '^docs:'
- '^test:'

# TODO(@cszatmary): Figure out releases
release:
github:
owner: getshiphub
name: shed

# TODO(@cszatmary): Figure out homebrew release
# brews:
# - github:
# owner: getshiphub
Expand All @@ -55,16 +54,9 @@ changelog:
# email: cs@christopherszatmary.com
# folder: Formula
# description: "Easily manage Go tool dependencies"

# test: |
# system "#{bin}/shed --version"
# install: |
# bin.install "shed"
# bash_completion.install "dist/completions/shed.bash"
# zsh_completion.install "dist/completions/_shed"

# release:
# github:
# owner: getshiphub
# name: shed
# name_template: "{{.ProjectName}}-v{{.Version}}"
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -65,3 +65,7 @@ test-ci:
@go test -coverpkg=$(COVERPKGS) -coverprofile=coverage/coverage.txt ./...
@go tool cover -func=coverage/coverage.txt
.PHONY: test-ci

# Generate install script to download binaries
scripts/install.sh: .goreleaser.yml
@$(SHED) run godownloader .goreleaser.yml > $@
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,27 @@ It is built on top of Go Modules, and allows for reproducible dev environments.

## Installation

Currently the way to get shed is using `go get`:
#### Binary Release

```
go get github.com/getshiphub/shed
curl -sSfL https://github.com/getshiphub/shed/master/scripts/install.sh | sh -s -- -b /usr/local/bin
```

This will install it to `/usr/local/bin/shed`. You can specify a different path to `-b` to customize the install location.

You can also install a specific version by providing the git tag as an argument.

```
curl -sSfL https://github.com/getshiphub/shed/master/scripts/install.sh | sh -s -- -b /usr/local/bin v0.1.0
```

Binary releases coming soon.
#### Install from source

You can also install shed using `go get`:

```
go get github.com/getshiphub/shed
```

## Usage

Expand Down
Loading

0 comments on commit f3905d4

Please sign in to comment.