Release action (AMReX-Astro#1025)

This creates an action which will automatically create a release whenever a version is tagged that matches the format xx.xx. The release text is scraped from CHANGES.md using a python script. If no text is found matching the tag, then it is left blank.

.github/workflows/create_release.yml

@@ -0,0 +1,36 @@
+on:
+  push:
+    # Sequence of patterns matched against refs/tags
+    tags:
+      - '[0-9][0-9].[0-9][0-9]' 
+
+name: Create Release
+
+jobs:
+  build:
+    name: Create Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Get the version
+        id: get_version
+        run: echo ::set-env name=VERSION::${GITHUB_REF/refs\/tags\//}
+
+      - name: Set release text
+        id: release_txt
+        run: |
+          python3 .github/workflows/get_release_txt.py ${{ env.VERSION }}
+
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: Release ${{ github.ref }}
+          body: ${{ env.RELEASE_TXT }}
+          draft: false
+          prerelease: false

.github/workflows/get_release_txt.py

@@ -0,0 +1,37 @@
+#!/usr/bin/env python3
+
+"""
+Get the text for the release from CHANGES.md
+"""
+
+import re
+import sys
+
+if __name__ == "__main__":
+    if len(sys.argv) < 2:
+        print('No version provided!')
+    else:
+        gen_version_re = re.compile(r'#\s(\d\d\.\d\d)')
+        this_version_re = re.compile(f'#\s{sys.argv[1]}')
+
+        with open('CHANGES.md', 'r') as file:
+            txt = file.read()
+            m = re.search(this_version_re, txt)
+            if m:
+                # find next date
+                m_next = re.search(gen_version_re, txt[m.end():])
+                if m_next:
+                    txt = txt[m.end():m.end()+m_next.start()].strip()
+                else:
+                    txt = txt[m.end():].strip()
+            else:
+                txt = ""
+
+            # we now need to substitute characters in the string so that 
+            # the action can deal with line breaks 
+            txt = txt.replace('%', '%25')
+            txt = txt.replace('\n', '%0A')
+            txt = txt.replace('\r', '%0D')
+            txt = txt.replace('%0A   *', '%0A*')
+
+            print(f'::set-env name=RELEASE_TXT::{txt}')

Docs/source/visualization.rst

@@ -63,4 +63,4 @@ Example notebook
 
 Using the plotfiles generated in the example in the :doc:`getting_started` section, here we demonstrate how to use ``yt`` to load and visualize data. This section was generated from a Jupyter notebook which can be found in ``Docs/source/yt_example.ipynb`` in the Castro repo. 
 
-.. include:: yt_example.rst
+.. include:: yt_example.rst

requirements.txt

@@ -8,4 +8,4 @@ numpy
 IPython>=3
 nbconvert
 pandoc
-jupyter
+jupyter