From d37c216da37f04773274a9d6677a264c55bb8812 Mon Sep 17 00:00:00 2001
From: "Julio A. Peraza" <52050407+JulioAPeraza@users.noreply.github.com>
Date: Tue, 31 May 2022 09:54:21 -0400
Subject: [PATCH] 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 04c324f7dd0e4b003882b9e56df95273f98e1d29.

* testing github action

* Revert "testing github action"

This reverts commit d9e0c888272e7208bb3fc735136ea58d1ba3961f.
---
 .github/workflows/update-changelog.yml | 28 ++++++++++++++++++++++++++
 CHANGELOG.md                           |  7 +++++++
 docs/changelog.rst                     |  1 +
 docs/index.rst                         |  1 +
 4 files changed, 37 insertions(+)
 create mode 100644 .github/workflows/update-changelog.yml
 create mode 100644 CHANGELOG.md
 create mode 100644 docs/changelog.rst

diff --git a/.github/workflows/update-changelog.yml b/.github/workflows/update-changelog.yml
new file mode 100644
index 000000000..942fd2b19
--- /dev/null
+++ b/.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
\ No newline at end of file
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 000000000..2e1de46e2
--- /dev/null
+++ b/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 -->
\ No newline at end of file
diff --git a/docs/changelog.rst b/docs/changelog.rst
new file mode 100644
index 000000000..5ec4a0ecb
--- /dev/null
+++ b/docs/changelog.rst
@@ -0,0 +1 @@
+.. mdinclude:: ../CHANGELOG.md
\ No newline at end of file
diff --git a/docs/index.rst b/docs/index.rst
index 769f9fbeb..f200cbe64 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -66,6 +66,7 @@ To install NiMARE check out our `installation guide`_.
    cli
    outputs
    methods
+   changelog
 
 Indices and tables
 ------------------