-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* README.md: add installation and usage instructions * Publish artifacts to a corresponding GitHub release * Create releases with GoReleaser * CI: use only_if check and goreleaser:latest image * README.md: clarify WIP status
- Loading branch information
Showing
3 changed files
with
51 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
project_name: cirrus | ||
|
||
before: | ||
hooks: | ||
- go mod download | ||
|
||
builds: | ||
- main: cmd/cirrus/main.go | ||
env: | ||
- CGO_ENABLED=0 | ||
goos: | ||
- linux | ||
goarch: | ||
- amd64 | ||
|
||
archives: | ||
- format: zip |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,29 @@ | ||
# cirrus-cli | ||
CLI for executing Cirrus tasks locally | ||
# Cirrus CLI | ||
|
||
WIP CLI for executing Cirrus tasks locally. Currently can only validate Cirrus CI configuration file. | ||
|
||
## Installation | ||
|
||
### Releases | ||
|
||
Check the [releases page](https://github.com/cirruslabs/cirrus-cli/releases) for a pre-built `cirrus` binary for your platform. | ||
|
||
### Go | ||
|
||
If you have Go 1.14 installed, you can run: | ||
|
||
``` | ||
go install github.com/cirruslabs/cirrus-cli/... | ||
``` | ||
|
||
This will build and place the `cirrus` binary in `$GOPATH/bin`. | ||
|
||
To be able to run `cirrus` command from anywhere, make sure that the `$GOPATH/bin` directory is added to your `PATH` environment variable (see [article in the Go wiki](https://github.com/golang/go/wiki/SettingGOPATH) for more details). | ||
|
||
## Usage | ||
|
||
To validate a Cirrus CI configuration, simply switch to a directory where the `.cirrus.yml` is located and run: | ||
|
||
``` | ||
cirrus validate | ||
``` |