Skip to content

Commit

Permalink
Use a CHANGELOG file (#5)
Browse files Browse the repository at this point in the history
  • Loading branch information
ilazakis authored May 31, 2020
1 parent b8211d3 commit 3f3dc27
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 4 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,6 @@ kenza/data/

# mkdocs documentation
/site

# Ephemeral CHANGELOG entries
CHANGELOG-*
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`:
Expand Down
8 changes: 6 additions & 2 deletions release.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 3f3dc27

Please sign in to comment.