Generate automatic CHANGELOG from release note and add it to docs (#684)

* generate automatic changelog from release note and add it to the docstring

* fix changelog in doc

* Add Unreleased note to CHANGELOG, and test workflow

* Update update-changelog.yml

* update CHANGELOG when a PR is closed

* Update update-changelog.yml

* write previous releases note

* Revert "write previous releases note"

This reverts commit 04c324f.

* testing github action

* Revert "testing github action"

This reverts commit d9e0c88.

.github/workflows/update-changelog.yml

@@ -0,0 +1,28 @@
+name: "Update Changelog"
+
+on:
+  release:
+    types: [released]
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          ref: main
+
+      - name: Update Changelog
+        uses: stefanzweifel/changelog-updater-action@v1
+        with:
+          latest-version: ${{ github.event.release.tag_name }}
+          release-notes: ${{ github.event.release.body }}
+
+      - name: Commit updated CHANGELOG
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          branch: main
+          commit_message: Update CHANGELOG
+          file_pattern: CHANGELOG.md

CHANGELOG.md

@@ -0,0 +1,7 @@
+# CHANGELOG
+
+All notable changes to NiMARE releases are documented in this page.
+
+## [Unreleased](https://github.com/neurostuff/NiMARE/compare/0.0.12rc2...HEAD)
+
+<!-- New Release notes will be placed here automatically -->

docs/changelog.rst

@@ -0,0 +1 @@
+.. mdinclude:: ../CHANGELOG.md

docs/index.rst

@@ -66,6 +66,7 @@ To install NiMARE check out our `installation guide`_.
    cli
    outputs
    methods
+   changelog
 
 Indices and tables
 ------------------