ci: include release notes on release page

Author: wpbonelli

.github/common/body.md.jinja

@@ -0,0 +1,18 @@
+MODFLOW 6 development build, {{ date }}.
+
+{% for section_key, section_items in items|groupby("section") %}
+{% set section = sections[section_key]|title %}
+## {{ section }}
+
+{% for subsection_key, subsection_items in section_items|groupby("subsection") %}
+{% set subsection = subsections[subsection_key]|title %}
+{% if subsection|length > 0 %}
+### {{ subsection }}
+{% endif %}
+
+{% for item in subsection_items %}
+- {{ item.description }}
+{% endfor %}
+
+{% endfor %}
+{% endfor %}

.github/common/make_body.py

@@ -0,0 +1,58 @@
+# This script converts the release notes TOML file
+# to markdown, which is added to the release page.
+import argparse
+import datetime
+import sys
+from pathlib import Path
+from warnings import warn
+
+DATE = datetime.date.today().strftime("%b %d, %Y")
+TEMPLATE_PATH = Path(__file__).parent / "body.md.jinja"
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    parser.add_argument("toml_path")
+    parser.add_argument("md_path")
+    args = parser.parse_args()
+    toml_path = Path(args.toml_path).expanduser().absolute()
+    md_path = Path(args.md_path).expanduser().absolute()
+    if not toml_path.is_file():
+        warn(f"Release notes TOML file not found: {toml_path}")
+        sys.exit(0)
+
+    md_path.unlink(missing_ok=True)
+
+    import tomli
+    from jinja2 import Environment, FileSystemLoader
+
+    loader = FileSystemLoader(Path(__file__).parent)
+    env = Environment(
+        loader=loader,
+        trim_blocks=True,
+        lstrip_blocks=True,
+        line_statement_prefix="_",
+        keep_trailing_newline=True,
+    )
+    template = env.get_template(TEMPLATE_PATH.name)
+    with open(md_path, "w") as md_file:
+        with open(toml_path, "rb") as toml_file:
+            content = tomli.load(toml_file)
+            sections = content.get("sections", [])
+            subsections = content.get("subsections", [])
+            items = content.get("items", [])
+            # make sure each item has a subsection entry even if empty
+            for item in items:
+                if not item.get("subsection"):
+                    item["subsection"] = ""
+            if not any(items):
+                warn("No release notes found, aborting")
+                sys.exit(0)
+            md_file.write(
+                template.render(
+                    sections=sections,
+                    subsections=subsections,
+                    items=items,
+                    date=DATE,
+                )
+            )

.github/workflows/nightly-build.yml

@@ -95,6 +95,25 @@ jobs:
     if: github.event_name != 'pull_request'
     steps:
 
+      - name: Checkout repo
+        uses: actions/checkout@v4
+        with:
+          repository: MODFLOW-ORG/modflow6-nightly-build
+
+      - name: Checkout modflow6
+        uses: actions/checkout@v4
+        with:
+          repository: MODFLOW-ORG/modflow6
+          path: modflow6
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.9
+
+      - name: Install Python packages
+        run: pip install -r requirements.txt
+
       - name: Delete Older Releases
         uses: dev-drprasad/delete-older-releases@v0.3.4
         with:
@@ -138,12 +157,16 @@ jobs:
           F_TIME: "${{ steps.current-time.outputs.formattedTime }}"
         run: echo $TIME $F_TIME
 
+      - name: Make body
+        id: make-body
+        run: python .github/common/make_body.py modflow6/doc/ReleaseNotes/develop.toml body.md
+
       - name: Create release
         uses: ncipollo/release-action@v1
         with:
           tag: ${{ steps.current-time.outputs.formattedTime }}
           name: ${{ steps.current-time.outputs.formattedTime }} development build
-          body: "MODFLOW 6 development build."
+          bodyFile: body.md
           draft: false
           allowUpdates: true
           token: ${{ secrets.GITHUB_TOKEN }}

requirements.txt

@@ -3,4 +3,6 @@ https://github.com/MODFLOW-ORG/modflow-devtools/archive/develop.zip
 flopy[test, optional]
 meson!=0.63.0
 mfpymake
-ninja
+ninja
+tomli
+Jinja2