add changelog

CHANGELOG.rst

@@ -6,13 +6,14 @@ 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/changelog.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 
 

pyproject.toml

@@ -135,8 +135,8 @@ fallback_version = "0.3.dev0"
 
 [tool.towncrier]
 directory = "upcoming_changes/"
-filename = "CHANGES.rst"
-issue_format = "`#{issue} <https://github.com/hyperspy/lumispy/issues/{issue}>`_"
+filename = "CHANGELOG.rst"
+issue_format = "`#{issue} <https://github.com/lumispy/lumispy/issues/{issue}>`_"
 title_format = "{version} ({project_date})"
 package_dir = "lumispy"
 type = [

upcoming_changes/211.doc.rst

@@ -0,0 +1 @@
+Use ``towncrier`` to manage changelog 

upcoming_changes/211.maintenance.rst

@@ -0,0 +1,5 @@
+Streamline project files and release workflow to match HyperSpy ecosystem:
+
+- Migrate to ``pyproject.toml`` from ``setup.py``
+- Use ``setuptools-scm`` to set version at build time
+- Adapt release workflow, e.g. mine doi only after successful upload