add changelog

marcosh · Mar 17, 2023 · 5f5331e · 5f5331e
1 parent 2b39027
commit 5f5331e
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 0 deletions.
diff --git a/CHANGELOG.md 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/1.1.0/),
+and this project adheres to [PVP](https://pvp.haskell.org/).
+
+## [0.1.0.0] - 2023-03-17
+
+### Added
+
+- 🎉 everything's new! first release!
diff --git a/README.md b/README.md
@@ -122,6 +122,10 @@ We have a `cabal` flag called `errors` which allows enabling `-Werror`. It has a
 
 In development and CI we use the flag `-f errors` so that we can avoid any warning in the library code.
 
+### Changelog
+
+All changes are tracked in the [`Changelog`](CHANGELOG.md).
+
 ## Project setup
 
 You can find more details on the project setup on [Setup.md](/Setup.md).

diff --git a/crem.cabal b/crem.cabal
@@ -22,6 +22,8 @@ tested-with:
  , GHC ==9.2.7
  , GHC ==9.4.4
  , GHC ==9.6.1
+extra-source-files:
+ CHANGELOG.md
 
 flag errors
  description: enable -Werror

diff --git a/package.yaml b/package.yaml
@@ -20,6 +20,9 @@ tested-with:
  - GHC ==9.4.4
  - GHC ==9.6.1
 
+extra-source-files:
+ - CHANGELOG.md
+
 flags:
  errors:
  description: enable -Werror