Skip to content

Record your screen, ship a demo. Free and open-source, GPU-accelerated, no watermarks, no subscriptions. Windows, macOS, Linux. Actively maintained.

ci: put one star line at the head of stable release notes

EtienneLescot9c345ee159b9
diff --git a/.github/scripts/stable-release-notes.test.mjs b/.github/scripts/stable-release-notes.test.mjs
new file mode 100644
index 000000000..2d3590035
--- /dev/null
+++ b/.github/scripts/stable-release-notes.test.mjs
@@ -0,0 +1,63 @@
+import fs from "node:fs";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import { describe, expect, it } from "vitest";
+
+// Asserted against the workflow text, the way scripts/ffmpeg-linked-libraries.test.mjs already
+// checks workflow facts: there is no unit to import here, the behaviour IS the `gh` invocation,
+// and the only other way to learn this is to cut a release and read the result.
+const repoRoot = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "../..");
+const buildWorkflow = fs.readFileSync(path.join(repoRoot, ".github/workflows/build.yml"), "utf8");
+
+/** The RC and stable paths are the two arms of one `if [[ -n "$PRERELEASE_FLAG" ]]`, so slicing
+ * on the `else` keeps a change to one arm from silently satisfying an assertion about the
+ * other — which is the whole failure this file exists to catch. */
+function releaseNotesArms() {
+ const start = buildWorkflow.indexOf('if [[ -n "$PRERELEASE_FLAG" ]]; then');
+ const create = buildWorkflow.indexOf('gh release create "$TAG"', start);
+ expect(start).toBeGreaterThan(-1);
+ expect(create).toBeGreaterThan(start);
+ const block = buildWorkflow.slice(start, create);
+ const split = block.indexOf("\n else\n");
+ expect(split).toBeGreaterThan(-1);
+ return { rc: block.slice(0, split), stable: block.slice(split) };
+}
+
+describe("stable release notes", () => {
+ it("prepends the star line to every stable release", () => {
+ const { stable } = releaseNotesArms();
+ expect(stable).toContain(
+ 'STAR_LINE="If OpenScreen saves you time, a star on the repo helps others find it."',
+ );
+ // Both branches of the notes-start-tag choice, not just the one that happens to come
+ // first: a release cut with no previous tag is exactly when nobody is watching.
+ for (const args of stable.match(/NOTES_ARGS=\([^)]*\)/g) ?? []) {
+ expect(args).toContain("--generate-notes");
+ expect(args).toContain('--notes "$STAR_LINE"');
+ }
+ expect(stable.match(/NOTES_ARGS=\([^)]*\)/g)).toHaveLength(2);
+ });
+
+ it("leaves release candidates alone", () => {
+ const { rc } = releaseNotesArms();
+ // An RC body is built from git log into a file. A --notes there would not prepend, it
+ // would be a second, conflicting source for the same body.
+ expect(rc).not.toContain("STAR_LINE");
+ // Asserted on the arguments, never on the arm's text: the RC branch carries a comment
+ // that says "not --generate-notes", and a substring check happily matches the prose.
+ const args = rc.match(/NOTES_ARGS=\([^)]*\)/g) ?? [];
+ expect(args).toHaveLength(1);
+ expect(args[0]).toContain("--notes-file");
+ expect(args[0]).not.toContain("--generate-notes");
+ expect(args[0]).not.toContain("--notes ");
+ });
+
+ it("keeps the generated notes rather than replacing them", () => {
+ // `--notes` alongside `--generate-notes` is documented as a PREPEND, so the PR links and
+ // the New Contributors section survive. Drop `--generate-notes` and the star line becomes
+ // the entire release body — a silent, total loss of the notes nobody would notice until
+ // after the release is public.
+ const { stable } = releaseNotesArms();
+ expect(stable).not.toMatch(/NOTES_ARGS=\((?![^)]*--generate-notes)[^)]*\)/);
+ });
+});
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 9b3beb623..387bed2b9 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -976,10 +976,20 @@ jobs:
# string or a commit SHA is an invalid argument, not a graceful
# degradation. Without it GitHub falls back to its own choice of
# previous release, which is exactly right when there isn't one.
+ # One line at the head of the body, stable only. `--notes` alongside
+ # `--generate-notes` PREPENDS rather than replaces: the create-release
+ # API documents body as "pre-pended to the automatically generated
+ # notes", and `gh release create --help` says the same. So the PR
+ # links and the New Contributors section below are untouched.
+ #
+ # Not on an RC: an RC goes to people who already follow the repo, and
+ # its body comes from --notes-file above, where a --notes would be a
+ # conflicting second source rather than a prefix.
+ STAR_LINE="If OpenScreen saves you time, a star on the repo helps others find it."
if [[ -n "$NOTES_START_TAG" ]]; then
- NOTES_ARGS=(--generate-notes --notes-start-tag "$NOTES_START_TAG")
+ NOTES_ARGS=(--generate-notes --notes-start-tag "$NOTES_START_TAG" --notes "$STAR_LINE")
else
- NOTES_ARGS=(--generate-notes)
+ NOTES_ARGS=(--generate-notes --notes "$STAR_LINE")
fi
fi
# shellcheck disable=SC2086