Skip to content

Commit

Permalink
Add rever for changelog and backfill news (#77)
Browse files Browse the repository at this point in the history
* add rever and backfill changes

* add back fill news

* update changelog

* remove changelog entries
  • Loading branch information
jthorton authored Dec 6, 2024
1 parent 3f529d7 commit b27eabd
Show file tree
Hide file tree
Showing 7 changed files with 84 additions and 0 deletions.
18 changes: 18 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -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/>.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -96,3 +96,6 @@ src/kartograf/_version.py
#IDE
.idea
/src/kartograf/dev/

# Rever
rever/
5 changes: 5 additions & 0 deletions docs/CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
====================
Kartograf Change Log
====================

.. current developments
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,6 @@ You can find our Preprint on `Ries, B.; Alibay, I.; Swenson, D. W. H; Baumann, H
tutorial
guide
api
CHANGELOG


23 changes: 23 additions & 0 deletions news/TEMPLATE.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Added:**

* <news item>

**Changed:**

* <news item>

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

* <news item>

**Security:**

* <news item>
27 changes: 27 additions & 0 deletions news/backfill.rst
Original file line number Diff line number Diff line change
@@ -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>
7 changes: 7 additions & 0 deletions rever.xsh
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
$PROJECT = $GITHUB_REPO = 'kartograf'
$GITHUB_ORG = 'OpenFreeEnergy'

$ACTIVITIES = ['changelog']

$CHANGELOG_FILENAME = 'docs/CHANGELOG.rst'
$CHANGELOG_TEMPLATE = 'TEMPLATE.rst'

0 comments on commit b27eabd

Please sign in to comment.