Migrate to markdown changelog

compas-rrc · Mar 27, 2024 · a77fed9 · a77fed9
1 parent 4e2be4b
commit a77fed9
Show file tree

Hide file tree

Showing 7 changed files with 31 additions and 45 deletions.
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -13,9 +13,9 @@ search = {current_version}
 replace = {new_version}
 	{current_version}
 
-[bumpversion:file:CHANGELOG.rst]
+[bumpversion:file:CHANGELOG.md]
 search = Unreleased
-replace = {new_version}
+replace = [{new_version}] {now:%Y-%m-%d}
 
 [bumpversion:file:src/compas_rrc/__version__.py]
 search = __version__ = '{current_version}'

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -13,7 +13,7 @@
 
 _Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._
 
-- [ ] I added a line to the `CHANGELOG.rst` file in the `Unreleased` section under the most fitting heading (e.g. `Added`, `Changed`, `Removed`).
+- [ ] I added a line to the `CHANGELOG.md` file in the `Unreleased` section under the most fitting heading (e.g. `Added`, `Changed`, `Removed`).
 - [ ] I ran all tests on my computer and it's all green (i.e. `invoke test`).
 - [ ] I ran lint on my computer and there are no errors (i.e. `invoke lint`).
 - [ ] I have added tests that prove my fix is effective or that my feature works.

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,27 @@
+# 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.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+### Added
+
+* Added `to_configuration` and `to_configuration_primitive` to `compas_rrc.ExternalAxes` and `compas_rrc.RobotJoints`
+
+### Changed
+
+### Removed
+
+## 1.1.0
+
+### Added
+
+* Prepared github actions for continuous integration
+* Added compas plugin for automatic Rhino install
+
+## 1.0.0
+
+* Initial version
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -10,7 +10,7 @@ include .bumpversion.cfg
 include .editorconfig
 
 include AUTHORS.rst
-include CHANGELOG.rst
+include CHANGELOG.md
 include CONTRIBUTING.rst
 include LICENSE
 include README.rst

diff --git a/docs/changelog.rst b/docs/changelog.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -21,7 +21,6 @@ Contents
    contributing
    architecture
    authors
-   changelog
    citing
 
 Indices and tables