Merge pull request natcap#1681 from emilyanndavis/feature/1368-display-changelog-in-workbench

Feature/1368 display changelog in workbench

Author: davemfish

.github/workflows/release-part-1.yml

@@ -53,7 +53,24 @@ jobs:
           perl -0777 -i -pe \
               "s/Unreleased Changes\n------------------/..\n  Unreleased Changes\n  ------------------\n\n${HEADER}\n${UNDERLINE}/g" \
               HISTORY.rst
+
+      - name: Install dependencies
+        run: pip install rst2html5
+
+      - name: Generate changelog.html
+        run: rst2html5 HISTORY.rst workbench/changelog.html
+
+      - name: Update package.json version
+        uses: BellCubeDev/update-package-version-by-release-tag@v2
+        with:
+          version: ${{ inputs.version }}
+          package-json-path: workbench/package.json
+
+      - name: Commit updated HISTORY.rst, changelog.html, and package.json
+        run: |
           git add HISTORY.rst
+          git add workbench/changelog.html
+          git add workbench/package.json
           git commit -m "Committing the $VERSION release."
 
       - name: Tag and push

HISTORY.rst

@@ -48,6 +48,21 @@ Unreleased Changes
       reflect changes in how InVEST is installed on modern systems, and also to
       include images of the InVEST workbench instead of just broken links.
       https://github.com/natcap/invest/issues/1660
+* Workbench
+    * Several small updates to the model input form UI to improve usability
+      and visual consistency (https://github.com/natcap/invest/issues/912).
+    * Fixed a bug that caused the application to crash when attempting to
+      open a workspace without a valid logfile
+      (https://github.com/natcap/invest/issues/1598).
+    * Fixed a bug that was allowing readonly workspace directories on Windows
+      (https://github.com/natcap/invest/issues/1599).
+    * Fixed a bug that, in certain scenarios, caused a datastack to be saved
+      with relative paths when the Relative Paths checkbox was left unchecked
+      (https://github.com/natcap/invest/issues/1609).
+    * Improved error handling when a datastack cannot be saved with relative
+      paths across drives (https://github.com/natcap/invest/issues/1608).
+    * The InVEST changelog now displays in the Workbench the first time a new
+      version is launched (https://github.com/natcap/invest/issues/1368).
 * Coastal Vulnerability
     * Fixed a regression where an AOI with multiple features could raise a
       TypeError after intersecting with the landmass polygon.
@@ -75,19 +90,6 @@ Unreleased Changes
     * The model now works as expected when the user provides an LULC raster
       that does not have a nodata value defined.
       https://github.com/natcap/invest/issues/1293
-* Workbench
-    * Several small updates to the model input form UI to improve usability
-      and visual consistency (https://github.com/natcap/invest/issues/912).
-    * Fixed a bug that caused the application to crash when attempting to
-      open a workspace without a valid logfile
-      (https://github.com/natcap/invest/issues/1598).
-    * Fixed a bug that was allowing readonly workspace directories on Windows
-      (https://github.com/natcap/invest/issues/1599).
-    * Fixed a bug that, in certain scenarios, caused a datastack to be saved
-      with relative paths when the Relative Paths checkbox was left unchecked
-      (https://github.com/natcap/invest/issues/1609).
-    * Improved error handling when a datastack cannot be saved with relative
-      paths across drives (https://github.com/natcap/invest/issues/1608).
 
 3.14.2 (2024-05-29)
 -------------------

Makefile

@@ -66,13 +66,16 @@ PYTHON_ARCH := $(shell $(PYTHON) -c "import sys; print('x86' if sys.maxsize <= 2
 
 GSUTIL := gsutil
 SIGNTOOL := SignTool
+RST2HTML5 := rst2html5
 
 # local directory names
 DIST_DIR := dist
 DIST_DATA_DIR := $(DIST_DIR)/data
 BUILD_DIR := build
 WORKBENCH := workbench
 WORKBENCH_DIST_DIR := $(WORKBENCH)/dist
+CHANGELOG_SRC := HISTORY.rst
+CHANGELOG_DEST := $(WORKBENCH)/changelog.html
 
 # The fork name and user here are derived from the git path on github.
 # The fork name will need to be set manually (e.g. make FORKNAME=natcap/invest)
@@ -141,6 +144,7 @@ help:
 	@echo "  binaries          to build pyinstaller binaries"
 	@echo "  apidocs           to build HTML API documentation"
 	@echo "  userguide         to build HTML version of the users guide"
+	@echo "  changelog         to build HTML version of the changelog"
 	@echo "  python_packages   to build natcap.invest wheel and source distributions"
 	@echo "  codesign_mac      to sign the mac disk image using the codesign utility"
 	@echo "  codesign_windows  to sign the windows installer using the SignTool utility"
@@ -366,6 +370,9 @@ deploy:
 	@echo "Application binaries (if they were created) can be downloaded from:"
 	@echo "  * $(DOWNLOAD_DIR_URL)"
 
+changelog:
+	$(RST2HTML5) $(CHANGELOG_SRC) $(CHANGELOG_DEST)
+
 # Notes on Makefile development
 #
 # * Use the -drR to show the decision tree (and none of the implicit rules)

requirements-dev.txt

@@ -26,3 +26,4 @@ requests
 coverage
 xlwt
 build  # pip-only
+rst2html5