docs and scripts

nosqlbench · Jan 24, 2023 · 402154e · 402154e
1 parent ee2bda2
commit 402154e
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 3 deletions.
diff --git 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
@@ -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
@@ -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 → RELEASE_NOTES.md b/RELEASENOTES.md → RELEASE_NOTES.md
diff --git a/scripts/trigger_preview_build.sh 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
@@ -0,0 +1,2 @@
+#!/bin/bash
+scripts/release-notes.sh > RELEASE_NOTES.md