From 402154e4c78598e1f293beefef8230ac51210b69 Mon Sep 17 00:00:00 2001
From: Jonathan Shook <jshook@gmail.com>
Date: Mon, 23 Jan 2023 20:04:45 -0600
Subject: [PATCH] docs and scripts

---
 .github/workflows/build.yml         | 7 +++++--
 .github/workflows/preview.yml       | 5 +++++
 .github/workflows/release.yml       | 7 ++++++-
 RELEASENOTES.md => RELEASE_NOTES.md | 0
 scripts/trigger_preview_build.sh    | 2 ++
 scripts/trigger_release_build.sh    | 2 ++
 6 files changed, 20 insertions(+), 3 deletions(-)
 rename RELEASENOTES.md => RELEASE_NOTES.md (100%)
 create mode 100644 scripts/trigger_preview_build.sh
 create mode 100644 scripts/trigger_release_build.sh

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index b77a3d7a30..2a9fbe58c0 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -1,10 +1,13 @@
 name: build
 
+# This workflow should run for any push or pull request which is neither
+# a preview build nor a release build.
+
 on:
   push:
     paths:
-      - "!RELEASENOTES.md"
-      - "!PRERELEASE_NOTES.md"
+      - "!RELEASE_NOTES.md"
+      - "!PREVIEW_NOTES.md"
   pull_request:
 
 jobs:
diff --git a/.github/workflows/preview.yml b/.github/workflows/preview.yml
index 3ff5a918a3..43087d5c55 100644
--- a/.github/workflows/preview.yml
+++ b/.github/workflows/preview.yml
@@ -1,5 +1,10 @@
 name: prerelease
 
+# This workflow should run for any push which is a preview build.
+# Preview builds are indicated with changes to PREVIEW_NOTES.md.
+# In order to effect this, you can do the following:
+#  scripts/release-notes.sh > PREVIEW_NOTES.md
+
 on:
   push:
     branches:
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 7e5f71c917..bd8695bc39 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -1,11 +1,16 @@
 name: release
 
+# This workflow should run for any push which is a preview build.
+# Preview builds are indicated with changes to PREVIEW_NOTES.md.
+# In order to effect this, you can do the following:
+#  scripts/release-notes.sh > RELEASE_NOTES.md
+
 on:
   push:
     branches:
       - main
     paths:
-      - RELEASENOTES.**
+      - RELEASE_NOTES.**
 
 jobs:
   release:
diff --git a/RELEASENOTES.md b/RELEASE_NOTES.md
similarity index 100%
rename from RELEASENOTES.md
rename to RELEASE_NOTES.md
diff --git a/scripts/trigger_preview_build.sh b/scripts/trigger_preview_build.sh
new file mode 100644
index 0000000000..50d9dd640e
--- /dev/null
+++ b/scripts/trigger_preview_build.sh
@@ -0,0 +1,2 @@
+#!/bin/bash
+scripts/release-notes.sh > PREVIEW_NOTES.md
diff --git a/scripts/trigger_release_build.sh b/scripts/trigger_release_build.sh
new file mode 100644
index 0000000000..2bcf449a2d
--- /dev/null
+++ b/scripts/trigger_release_build.sh
@@ -0,0 +1,2 @@
+#!/bin/bash
+scripts/release-notes.sh > RELEASE_NOTES.md