Add CI/CD

.github/workflows/lint.yml

@@ -0,0 +1,25 @@
+name: Lint
+
+on: [push]
+
+jobs:
+  lint:
+    name: Lint the code
+    runs-on: ubuntu-latest
+    container: golang:1.16
+
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@master
+
+      - name: Check formatting using gofmt
+        run: gofmt -s -l -d .
+
+      - name: Check for suspicious constructs using "go vet"
+        run: go vet ./...
+
+      - name: Lint the code using "golint"
+        run: go get -u golang.org/x/lint/golint && golint -set_exit_status ./...
+
+      - name: Run staticcheck
+        run: go get -u honnef.co/go/tools/cmd/staticcheck && staticcheck ./...

.github/workflows/release.yml

@@ -0,0 +1,36 @@
+name: Release
+
+on:
+  push: { tags: ["v*"] }
+
+jobs:
+  release:
+    name: Release new version
+    runs-on: ubuntu-latest
+    container: golang:1.16
+
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@master
+
+      - name: Build release
+        run: make release
+
+      - name: Release
+        uses: docker://antonyurchenko/git-release:latest
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DRAFT_RELEASE: "true"
+          PRE_RELEASE: "false"
+          CHANGELOG_FILE: "none"
+          ALLOW_EMPTY_CHANGELOG: "true"
+          ALLOW_TAG_PREFIX: "true"
+          RELEASE_NAME_PREFIX: "Release "
+        with:
+          args: |
+            ./build/spacelift-cli-darwin-amd64.tar.gz
+            ./build/spacelift-cli-darwin-arm64.tar.gz
+            ./build/spacelift-cli-linux-amd64.tar.gz
+            ./build/spacelift-cli-linux-arm64.tar.gz
+            ./build/spacelift-cli-windows-amd64.tar.gz
+            ./LICENSE

.github/workflows/security.yml

@@ -0,0 +1,48 @@
+name: Security
+
+on:
+  push: { branches: [main] }
+  pull_request: { branches: [main] }
+  schedule:
+    - cron: "19 7 * * 0"
+
+jobs:
+  codeql:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v1
+        with:
+          languages: "go"
+
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v1
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v1
+
+
+  gosec:
+    name: GoSec
+    runs-on: ubuntu-latest
+    env:
+      GO111MODULE: on
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Run GoSec Security Scanner
+        uses: securego/gosec@master
+        with:
+          args: "-severity=medium -no-fail -fmt sarif -out gosec-results.sarif ./..."
+
+      - name: Upload GoSec scan results to GitHub Security tab
+        uses: github/codeql-action/upload-sarif@v1
+        with:
+          sarif_file: "gosec-results.sarif"

.gitignore

@@ -11,3 +11,4 @@ spacelift-cli
 
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
+build

Makefile

@@ -0,0 +1,27 @@
+BINARY := spacelift-cli
+PKG := github.com/spacelift-io/spacelift-cli/cmd
+BUILD_FLAGS := -a -tags netgo -ldflags '-w -extldflags "-static"'
+
+darwin:
+	env GOOS=darwin GOARCH=amd64 CGO_ENABLED=0 go build $(BUILD_FLAGS) -o build/$(BINARY)-darwin-amd64 $(PKG)
+	env GOOS=darwin GOARCH=arm64 CGO_ENABLED=0 go build $(BUILD_FLAGS) -o build/$(BINARY)-darwin-arm64 $(PKG)
+
+linux:
+	env GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build $(BUILD_FLAGS) -o build/$(BINARY)-linux-amd64 $(PKG)
+	env GOOS=linux GOARCH=arm64 CGO_ENABLED=0 go build $(BUILD_FLAGS) -o build/$(BINARY)-linux-arm64 $(PKG)
+
+windows:
+	env GOOS=windows GOARCH=amd64 CGO_ENABLED=0 go build $(BUILD_FLAGS) -o build/$(BINARY)-windows-amd64 $(PKG)
+
+build: darwin linux windows
+
+release: build
+	cd build; tar -czf $(BINARY)-darwin-amd64.tar.gz $(BINARY)-darwin-amd64
+	cd build; tar -czf $(BINARY)-darwin-arm64.tar.gz $(BINARY)-darwin-arm64
+	cd build; tar -czf $(BINARY)-linux-amd64.tar.gz $(BINARY)-linux-amd64
+	cd build; tar -czf $(BINARY)-linux-arm64.tar.gz $(BINARY)-linux-amd64
+	cd build; tar -czf $(BINARY)-windows-amd64.tar.gz $(BINARY)-windows-amd64
+
+clean:
+	go clean
+	rm -rf build/$(BINARY)*

client/interface.go

@@ -2,6 +2,7 @@ package client
 
 import "context"
 
+// Client abstracts away Spacelift's client API.
 type Client interface {
 	// Query executes a single GraphQL query request.
 	Query(context.Context, interface{}, map[string]interface{}) error

client/session/api_key.go

@@ -9,6 +9,8 @@ import (
 	"github.com/shurcooL/graphql"
 )
 
+// FromAPIKey builds a Spacelift session from a combination of endpoint, API key
+// ID and API key secret.
 func FromAPIKey(ctx context.Context, client *http.Client) func(string, string, string) (Session, error) {
 	return func(endpoint, keyID, keySecret string) (Session, error) {
 		out := &apiKey{

client/session/github_token.go

@@ -9,6 +9,8 @@ import (
 	"github.com/shurcooL/graphql"
 )
 
+// FromGitHubToken builds a Spacelift session from a combination of endpoint,
+// and a GitHub access token.
 func FromGitHubToken(ctx context.Context, client *http.Client) func(string, string) (Session, error) {
 	return func(endpoint, accessToken string) (Session, error) {
 		out := &gitHubToken{

client/session/stored_credentials.go

@@ -6,6 +6,7 @@ import (
 	"net/http"
 )
 
+// CredentialsType represents the type of credentials being used.
 type CredentialsType uint
 
 const (
@@ -31,6 +32,7 @@ type StoredCredentials struct {
 	KeySecret   string          `json:"key_secret,omitempty"`
 }
 
+// Session creates a Spacelift Session from stored credentials.
 func (s *StoredCredentials) Session(ctx context.Context, client *http.Client) (Session, error) {
 	switch s.Type {
 	case CredentialsTypeAPIKey:

client/structs/run_state_transition.go

@@ -16,6 +16,7 @@ type RunStateTransition struct {
 	Username  *string  `graphql:"username"`
 }
 
+// About returns "header" information about the state transition.
 func (r *RunStateTransition) About() string {
 	parts := []string{
 		string(r.State),

client/structs/run_type.go

@@ -3,6 +3,7 @@ package structs
 // RunType is the type of the run.
 type RunType string
 
+// NewRunType takes a string and returns a pointer to a RunType.
 func NewRunType(in string) *RunType {
 	out := RunType(in)
 	return &out

cmd/internal/account/account.go

@@ -2,6 +2,7 @@ package account
 
 import "github.com/urfave/cli/v2"
 
+// Command encapsulates the account command subtree.
 func Command() *cli.Command {
 	return &cli.Command{
 		Name:   "account",

cmd/internal/stack/stack.go

@@ -9,6 +9,7 @@ import (
 	"github.com/spacelift-io/spacelift-cli/cmd/internal/authenticated"
 )
 
+// Command encapsulates the stack command subtree.
 func Command() *cli.Command {
 	return &cli.Command{
 		Name:   "stack",