Skip to content

Commit

Permalink
Release 0.0.4
Browse files Browse the repository at this point in the history
  • Loading branch information
alanconway committed Nov 6, 2024
1 parent ce70e58 commit 5152af7
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 14 deletions.
8 changes: 6 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,14 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased] - 2024-05-30
## [0.0.4] - 2024-05-30

### Added
- For REST operations that return lists, print newline-separated JSON objects (ndjson)
- Updated for API changes in korrel8r 0.7.3.
- feat: add tooltips to browser nodes.
- feat: Take bearer token from kube config by default.
- feat: --bearer-token option to set Authorization headers.
- feat: --insecure option, also fix arguments to goals command.

## [0.0.1] - 2024-05-30

Expand Down
17 changes: 6 additions & 11 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

all: lint test build

VERSION=0.0.4
Expand All @@ -8,27 +7,26 @@ include .bingo/Variables.mk
VERSION_TXT=pkg/build/version.txt
SWAGGER_SPEC=swagger.json
SWAGGER_CLIENT=pkg/swagger
KORREL8RCLI=./korrel8rcli

lint: $(VERSION_TXT) $(SWAGGER_CLIENT) $(GOLANGCI_LINT)
lint: $(SWAGGER_CLIENT) $(GOLANGCI_LINT)
go mod tidy
$(GOLANGCI_LINT) run ./...
@if grep -q github.com/korrel8r/korrel8r go.mod; then \
echo "ERROR: bad dependency: remove 'github.com/korrel8r/korrel8r' from go.mod"; \
exit 1; \
fi

build: lint
go build ./cmd/korrel8rcli

install: lint
go install ./cmd/korrel8rcli
build: $(KORREL8RCLI)
$(KORREL8RCLI): $(VERSION_TXT) $(SWAGGER_CLIENT)
go build -o $@ ./cmd/korrel8rcli

test:
go test -cover -race ./...
go tool covdata percent -i pkg/cmd/_covdata

clean:
rm -rfv $(SWAGGER_CLIENT) $(SWAGGER_SPEC)
rm -rfv $(SWAGGER_CLIENT) $(KORREL8RCLI)
git clean -dfx

run:
Expand All @@ -41,9 +39,6 @@ endif
$(VERSION_TXT): $(MAKEFILE_LIST)
echo $(VERSION) > $@

$(SWAGGER_SPEC): $(KORREL8R) ## Use bingo-installed korrel8r to generate spec.
$(KORREL8R) web --spec $@

$(SWAGGER_CLIENT): $(SWAGGER_SPEC) $(SWAGGER) ## Generate client packages.
@mkdir -p $@
cd $@ && $(SWAGGER) generate -q client -f $(abspath $(SWAGGER_SPEC))
Expand Down
33 changes: 33 additions & 0 deletions RELEASE.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
= Releasing a new version

Steps to release a new version X.Y.Z, for maintainers.

On branch `main`:

== Update CHANGELOG

Update CHANGELOG.md to reflect changes since last release, add the new release header.
Follow http://keepachangelog.com[these guidelines]. +
You can list git changes with:

git log --oneline $(git describe --abbrev=0)..

== Prepare for release

Edit Makefile and set 'VERSION=X.Y.Z' for the new release.
Make sure you are logged in to `quay.io/korrel8r` to push images.

make clean; make pre-release REGISTRY_BASE=quay.io/korrel8r

Use `git status` to verify that all changes are related to the version number change.

Commit and push you changes to `origin/main` with commit message 'Release X.Y.Z'

== Publish the release

make release REGISTRY_BASE=quay.io/korrel8r

This does the following:
- `make clean` and re-build, verify nothing changes and the working tree is clean.
- Creates and pushes the git tag 'vX.Y.Z'
- Updates the 'latest' image tag to point to the new images.
2 changes: 1 addition & 1 deletion swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -444,4 +444,4 @@
}
}
}
}
}

0 comments on commit 5152af7

Please sign in to comment.