Skip to content

Commit 3f3dc27

Browse files
authored
Use a CHANGELOG file (#5)
1 parent b8211d3 commit 3f3dc27

4 files changed

Lines changed: 23 additions & 4 deletions

File tree

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,6 @@ kenza/data/
1919

2020
# mkdocs documentation
2121
/site
22+
23+
# Ephemeral CHANGELOG entries
24+
CHANGELOG-*

CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/3.0.0/),
5+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
## [Unreleased]
8+
9+
## [0.0.1-alpha] - 2020-05-31
10+
### Added
11+
- Initial commit, docs, README and CHANGELOG.
12+
- Release config for publishing archives and binaries.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ Download the binary from the latest GitHub release:
1212

1313
```sh
1414
# Linux
15-
curl -L https://github.com/kenza-ai/kenza/releases/download/v0.0.1-alpha/kenza-linux-amd64 -o kenza
15+
curl -L https://github.com/kenza-ai/kenza/releases/download/v0.0.1-alpha/kenza_0.0.1-alpha_linux_amd64 -o kenza
1616
```
1717

1818
```sh
1919
# macOS
20-
curl -L https://github.com/kenza-ai/kenza/releases/download/v0.0.1-alpha/kenza-darwin-amd64 -o kenza
20+
curl -L https://github.com/kenza-ai/kenza/releases/download/v0.0.1-alpha/kenza_0.0.1-alpha_darwin_amd64 -o kenza
2121
```
2222

2323
Move it under a PATH directory, we prefer `/usr/local/bin`:

release.sh

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,11 @@ done
1717

1818
# 1. Tag the release
1919
git tag -a $tag -m "$tag"
20-
git push --tags
2120

2221
# 2. Release to GitHub
23-
goreleaser --rm-dist
22+
if goreleaser --release-notes=CHANGELOG-$tag.md ; then
23+
echo "Release succeeded"
24+
else
25+
echo "Release failed"
26+
git tag -d $tag && git push origin --delete $tag
27+
fi

0 commit comments

Comments
 (0)