add changelog

LumiSpy · May 3, 2024 · 0a6a88d · 0a6a88d
1 parent bb41700
commit 0a6a88d
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 6 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -6,13 +6,13 @@ 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.0.0/>`_,
 and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.
 
-UNRELEASED
-==========
-Changed
--------
+Changelog entries for the development version are available at
+https://lumispy.readthedocs.io/en/latest/changes.html
+
+.. towncrier-draft-entries:: |release| [UNRELEASED]
+
+.. towncrier release notes start
 
-Maintenance
------------
 - Fix intersphinx links to documentation of HyperSpy 2.0 and add linkchecker workflow
 - Align supported python versions (3.8-3.12) to HyperSpy 2.0 
 

diff --git a/upcoming_changes/211.doc.rst b/upcoming_changes/211.doc.rst
@@ -0,0 +1 @@
+Use ``towncrier`` to manage release notes
diff --git a/upcoming_changes/211.maintenance.rst b/upcoming_changes/211.maintenance.rst
@@ -0,0 +1 @@
+Migrate to ``pyproject.toml`` from ``setup.py``, use ``setuptools-scm`` to set version at build time, and adapt release workflow to HyperSpy ecosystem