From b27eabdb3a1c914a66b961963e555383c6ab19dc Mon Sep 17 00:00:00 2001
From: Josh Horton <joshua.horton@openforcefield.org>
Date: Fri, 6 Dec 2024 14:21:47 +0000
Subject: [PATCH] Add rever for changelog and backfill news (#77)

* add rever and backfill changes

* add back fill news

* update changelog

* remove changelog entries
---
 .github/pull_request_template.md | 18 ++++++++++++++++++
 .gitignore                       |  3 +++
 docs/CHANGELOG.rst               |  5 +++++
 docs/index.rst                   |  1 +
 news/TEMPLATE.rst                | 23 +++++++++++++++++++++++
 news/backfill.rst                | 27 +++++++++++++++++++++++++++
 rever.xsh                        |  7 +++++++
 7 files changed, 84 insertions(+)
 create mode 100644 .github/pull_request_template.md
 create mode 100644 docs/CHANGELOG.rst
 create mode 100644 news/TEMPLATE.rst
 create mode 100644 news/backfill.rst
 create mode 100644 rever.xsh

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000..0edffcb
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +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/kartograf/blob/main/LICENSE) and the **Developer Certificate of Origin** at <https://developercertificate.org/>.
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
index c7d03bd..4bc61a6 100644
--- a/.gitignore
+++ b/.gitignore
@@ -96,3 +96,6 @@ src/kartograf/_version.py
 #IDE
 .idea
 /src/kartograf/dev/
+
+# Rever
+rever/
\ No newline at end of file
diff --git a/docs/CHANGELOG.rst b/docs/CHANGELOG.rst
new file mode 100644
index 0000000..bfe3d52
--- /dev/null
+++ b/docs/CHANGELOG.rst
@@ -0,0 +1,5 @@
+====================
+Kartograf Change Log
+====================
+
+.. current developments
\ No newline at end of file
diff --git a/docs/index.rst b/docs/index.rst
index b4dcb8c..948ca36 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -27,5 +27,6 @@ You can find our Preprint on `Ries, B.; Alibay, I.; Swenson, D. W. H; Baumann, H
    tutorial
    guide
    api
+   CHANGELOG
 
 
diff --git a/news/TEMPLATE.rst b/news/TEMPLATE.rst
new file mode 100644
index 0000000..9a2b78a
--- /dev/null
+++ 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>
\ No newline at end of file
diff --git a/news/backfill.rst b/news/backfill.rst
new file mode 100644
index 0000000..48d5331
--- /dev/null
+++ b/news/backfill.rst
@@ -0,0 +1,27 @@
+**Added:**
+
+* Added changelog `PR#77 <https://github.com/OpenFreeEnergy/kartograf/pull/77>`_
+* Support mapping multi chain components `PR#47 <https://github.com/OpenFreeEnergy/kartograf/pull/47>`_
+* Option to not break fused rings when creating mappings `PR#56 <https://github.com/OpenFreeEnergy/kartograf/pull/54>`_
+* Added a citation.cff `PR#45 <https://github.com/OpenFreeEnergy/kartograf/pull/45>`_
+
+**Changed:**
+
+* Additional filters are now applied before defaults `PR#64 <https://github.com/OpenFreeEnergy/kartograf/pull/64>`_
+* Docs clean up `PR#66 <https://github.com/OpenFreeEnergy/kartograf/pull/66>`_
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* Removed unused scorer `PR#54 <https://github.com/OpenFreeEnergy/kartograf/pull/54>`_
+
+**Fixed:**
+
+* Ring hybridization filter `PR#65 <https://github.com/OpenFreeEnergy/kartograf/pull/65>`_
+
+**Security:**
+
+* <news item>
\ No newline at end of file
diff --git a/rever.xsh b/rever.xsh
new file mode 100644
index 0000000..728e71a
--- /dev/null
+++ b/rever.xsh
@@ -0,0 +1,7 @@
+$PROJECT = $GITHUB_REPO = 'kartograf'
+$GITHUB_ORG = 'OpenFreeEnergy'
+
+$ACTIVITIES = ['changelog']
+
+$CHANGELOG_FILENAME = 'docs/CHANGELOG.rst'
+$CHANGELOG_TEMPLATE = 'TEMPLATE.rst'
\ No newline at end of file