From 3f3dc270e9a4a03dd687467c0b058764f7fbb931 Mon Sep 17 00:00:00 2001 From: Joakim Lazakis Date: Sun, 31 May 2020 18:18:42 +0100 Subject: [PATCH] Use a CHANGELOG file (#5) --- .gitignore | 3 +++ CHANGELOG.md | 12 ++++++++++++ README.md | 4 ++-- release.sh | 8 ++++++-- 4 files changed, 23 insertions(+), 4 deletions(-) create mode 100644 CHANGELOG.md diff --git a/.gitignore b/.gitignore index 9c32b49..8c77841 100644 --- a/.gitignore +++ b/.gitignore @@ -19,3 +19,6 @@ kenza/data/ # mkdocs documentation /site + +# Ephemeral CHANGELOG entries +CHANGELOG-* \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..5295692 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,12 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/3.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +## [0.0.1-alpha] - 2020-05-31 +### Added +- Initial commit, docs, README and CHANGELOG. +- Release config for publishing archives and binaries. diff --git a/README.md b/README.md index 1cddfd2..376dd45 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,12 @@ Download the binary from the latest GitHub release: ```sh # Linux -curl -L https://github.com/kenza-ai/kenza/releases/download/v0.0.1-alpha/kenza-linux-amd64 -o kenza +curl -L https://github.com/kenza-ai/kenza/releases/download/v0.0.1-alpha/kenza_0.0.1-alpha_linux_amd64 -o kenza ``` ```sh # macOS -curl -L https://github.com/kenza-ai/kenza/releases/download/v0.0.1-alpha/kenza-darwin-amd64 -o kenza +curl -L https://github.com/kenza-ai/kenza/releases/download/v0.0.1-alpha/kenza_0.0.1-alpha_darwin_amd64 -o kenza ``` Move it under a PATH directory, we prefer `/usr/local/bin`: diff --git a/release.sh b/release.sh index bd6883f..4cf2aaf 100644 --- a/release.sh +++ b/release.sh @@ -17,7 +17,11 @@ done # 1. Tag the release git tag -a $tag -m "$tag" -git push --tags # 2. Release to GitHub -goreleaser --rm-dist +if goreleaser --release-notes=CHANGELOG-$tag.md ; then + echo "Release succeeded" +else + echo "Release failed" + git tag -d $tag && git push origin --delete $tag +fi