Add RELEASE file

getyourguide · Aug 8, 2023 · e814b1e · e814b1e
1 parent 17ebeef
commit e814b1e
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Changelog
 
-## 0.0.1
+All notable changes to this project will be documented in this file.
 
-Initial release.
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.0.1] - 2023-08-XX TODO
+
+### Added
+- Initial release.
diff --git a/RELEASE.md b/RELEASE.md
@@ -0,0 +1,15 @@
+# Release Notes
+
+All notable changes to this project will be documented in the [CHANGELOG](CHANGELOG) file. This format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+## Release process
+
+1.  In `package.json` update `version`.
+2.  In `CHANGELOG.md` add a new entry following the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) convention.
+3.  Create a release via the GitHub UI.
+    -   Set the tag to match the version
+    -   Set the title to match the version
+    -   Copy the contents of the release changelog to the description field
+
+Publishing the package is handled automatically.