Merge pull request #728 from OpenFreeEnergy/feat/add_changelog

Changelog automation
OpenFreeEnergy · Feb 16, 2024 · 2150c20 · 2150c20
2 parents 7b3c2fe + 5996129
commit 2150c20
Show file tree

Hide file tree

Showing 7 changed files with 80 additions and 3 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,3 +1,18 @@
+<!--
+Thank you for pull request.
+Below are a few things we ask you kindly to self-check before getting a review. Remove checks that are not relevant.
+-->
+
+<!--
+Please note any issues this fixes using [closing keywords]( https://help.github.com/articles/closing-issues-using-keywords/ ):
+-->
+
+<!--
+see https://regro.github.io/rever-docs/news.html for details on how to add news entry (you do not need to run the rever command)
+-->
+
+Checklist
+* [ ] Added a ``news`` entry
 
 ## Developers certificate of origin
 - [ ] I certify that this contribution is covered by the MIT License [here](https://github.com/OpenFreeEnergy/openfe/blob/main/LICENSE) and the **Developer Certificate of Origin** at <https://developercertificate.org/>.
diff --git a/.gitignore b/.gitignore
@@ -173,3 +173,6 @@ docs/ExampleNotebooks/
 
 # Some charge stuff
 *.model.pt
+
+# Rever
+rever/
diff --git a/docs/CHANGELOG.rst b/docs/CHANGELOG.rst
@@ -0,0 +1,5 @@
+=================
+openfe Change Log
+=================
+
+.. current developments
diff --git a/docs/index.rst b/docs/index.rst
@@ -65,13 +65,13 @@ The **OpenFE** toolkit provides open-source frameworks for calculating alchemica
 
         Reference guide on using the OpenFE CLI.
 
-    .. grid-item-card:: OpenFE Showcase
+    .. grid-item-card:: Changelog
         :img-top: _static/Showcase.svg
         :text-align: center
-        :link: tutorials/showcase_notebook
+        :link: CHANGELOG
         :link-type: doc
 
-        Tutorial notebook showing the sorts of things OpenFE can do.
+        Any notable changes in the package for each released version
 
     .. grid-item-card:: Relative Free Energy Protocol
         :img-top: _static/Rocket.svg
@@ -92,6 +92,7 @@ The **OpenFE** toolkit provides open-source frameworks for calculating alchemica
    guide/index
    cookbook/index
    reference/index
+   CHANGELOG
 
 Indices and tables
 ------------------

diff --git a/news/TEMPLATE.rst b/news/TEMPLATE.rst
@@ -0,0 +1,23 @@
+**Added:**
+
+* <news item>
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>
diff --git a/news/add_rever.rst b/news/add_rever.rst
@@ -0,0 +1,23 @@
+**Added:**
+
+* use rever to manage changelog
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>
diff --git a/rever.xsh b/rever.xsh
@@ -0,0 +1,7 @@
+$PROJECT = $GITHUB_REPO = 'openfe'
+$GITHUB_ORG = 'OpenFreeEnergy'
+
+$ACTIVITIES = ['changelog']
+
+$CHANGELOG_FILENAME = 'docs/CHANGELOG.rst'
+$CHANGELOG_TEMPLATE = 'TEMPLATE.rst'
-Original file line number
+Diff line change
@@ Expand Up / @@ -173,3 +173,6 @@ docs/ExampleNotebooks/ @@
     # Some charge stuff
     *.model.pt
+    # Rever
+    rever/