feat: support --dry-run, -n, DRY_RUN

Author: hugojosefson

.github/workflows/ci.yml

@@ -3,7 +3,7 @@ name: release
 on:
   push:
     branches:
-      - main
+      - "**"
 
 jobs:
   lint:
@@ -35,6 +35,7 @@ jobs:
       - run: deno task test
 
   release:
+    name: "release${{ github.ref_name != 'main' && ' (dry-run)' || '' }}"
     runs-on: ubuntu-latest
     needs:
       - lint
@@ -46,6 +47,6 @@ jobs:
         with:
           fetch-depth: 0
       - uses: denoland/setup-deno@v2
-      - run: deno run --allow-net --allow-env --allow-run shipit.ts
+      - run: "deno run --allow-net --allow-env --allow-run shipit.ts ${{ github.ref_name != 'main' && '--dry-run' || '' }}"
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -49,6 +49,9 @@ these are the most notable differences from upstream:
 - [x] Unit tests for the more complex commit messages.
 - [x] Update dependencies.
 - [ ] TODO: Bump version number in any `deno.json` and `deno.jsonc`.
+- [x] Dry-run mode, doesn't make any changes, but prints new version and release
+      notes.
+  - Use `--dry-run` or `-n` to enable, or set `DRY_RUN=1` in your environment.
 
 ## Usage
 
@@ -89,7 +92,7 @@ step.
 permissions:
 
 - `--allow-env`: It reads `GITHUB_TOKEN` from your local environment in order to
-  authenticate with GitHub. It can also read `VERBOSE`.
+  authenticate with GitHub. It can also read `DRY_RUN` and `VERBOSE`.
 - `--allow-run`: It needs to spawn subprocesses (`git`, `bash`) in order to
   gather information about your commits.
 - `--allow-net`: It needs to make outbound network requests to GitHub in order

README.md

@@ -12,7 +12,7 @@
     "test": "                     deno test --coverage --trace-leaks --allow-run --allow-env=VERBOSE",
     "test-watch": "               deno test --watch    --trace-leaks --allow-run --allow-env=VERBOSE",
     "coverage": "                 deno coverage",
-    "release": "                  deno task all && GITHUB_TOKEN=$(gh auth token) deno run --allow-env=GITHUB_TOKEN,VERBOSE --allow-net=api.github.com --allow-run=bash,git shipit.ts",
+    "release": "                  deno task all && GITHUB_TOKEN=$(gh auth token) deno run --allow-env=GITHUB_TOKEN,VERBOSE,DRY_RUN --allow-net=api.github.com --allow-run=bash,git shipit.ts",
     "bump-deps": "                deno task forall-files-no-yaml -- deno run --allow-env --allow-read=.,$HOME/.cache/deno,$HOME/.local/share/deno-wasmbuild --allow-write=.,$HOME/.local/share/deno-wasmbuild --allow-run=git --allow-net jsr:@molt/cli@0.19.8 --commit --prefix=\"chore: \"",
     "list-files": "               git ls-files | deno eval 'import{toText}from\"jsr:@std/streams@1.0.8\";console.log((await toText(Deno.stdin.readable)).split(\"\\n\").filter(f=>f.startsWith(\".github/workflows\")||/\\.((mj|j|t)sx?|jsonc?)$/.test(f)).filter(f=>{try{return !Deno.statSync(f).isDirectory}catch{}}).join(\"\\n\"))'",
     "foreach-file-no-json-yaml": "deno task list-files | grep -viE '\\.(jsonc?|ya?ml)$' | sh -c 'xargs -I {}      -- \"$@\"'",

deno.jsonc

@@ -9,7 +9,17 @@ export interface Commits {
   other: string[];
 }
 
-function generateNotes(
+/**
+ * Generates the release notes for a given version and {@link Commits}.
+ * @param version The version to generate notes for.
+ * @param major The commits that are considered major.
+ * @param minor The commits that are considered minor.
+ * @param patch The commits that are considered patch.
+ * @param docs The commits that are considered docs.
+ * @param other The commits that are considered other.
+ * @returns The release notes for the given version.
+ */
+export function generateReleaseNotes(
   version: string,
   { major, minor, patch, docs, other }: Commits,
 ): string {
@@ -47,7 +57,7 @@ function generateNotes(
 }
 
 export default {
-  async release(nextVer: string, commits: Commits): Promise<string> {
+  async release(nextVer: string, releaseNotes: string): Promise<string> {
     const { owner, repo } = await git.repoInfo();
 
     // Get the GitHub token from environment variables
@@ -56,9 +66,6 @@ export default {
       throw new Error("GITHUB_TOKEN environment variable is not set.");
     }
 
-    // Generate the release notes
-    const body = generateNotes(nextVer, commits);
-
     // Create a new release using the 'request' function
     const res = await request("POST /repos/{owner}/{repo}/releases", {
       headers: {
@@ -68,7 +75,7 @@ export default {
       repo,
       name: nextVer,
       tag_name: nextVer,
-      body,
+      body: releaseNotes,
     });
 
     return res.data.html_url;

github.ts

@@ -8,7 +8,7 @@ import {
 import * as colors from "@std/fmt/colors";
 import * as semver from "@std/semver";
 import git, { ROOT } from "./git.ts";
-import github from "./github.ts";
+import github, { type Commits, generateReleaseNotes } from "./github.ts";
 import { logHeader } from "./log.ts";
 
 if (!import.meta.main) {
@@ -79,6 +79,23 @@ if (ver !== ROOT) {
   console.log("Next version:", `${nextVer}\n`);
 }
 
+// Generate release notes.
+const commits: Commits = { major, minor, patch, docs, other };
+const releaseNotes = generateReleaseNotes(nextVer, commits);
+
+// If we're in dry run mode, just print the release notes and exit.
+if (
+  Deno.env.get("DRY_RUN") || Deno.args.includes("--dry-run") ||
+  Deno.args.includes("-n")
+) {
+  logHeader(
+    "DRY_RUN or --dry-run is set, so not pushing any tags, nor creating a release.",
+  );
+  console.log(`Release notes for ${nextVer} would be:`);
+  console.log(releaseNotes);
+  Deno.exit(0);
+}
+
 // Tag the new version.
 logHeader("Creating new remote tag...");
 await git.tag(nextVer);
@@ -90,7 +107,7 @@ logHeader("Creating new GitHub release...");
 
 let url: string;
 try {
-  url = await github.release(nextVer, { major, minor, patch, docs, other });
+  url = await github.release(nextVer, releaseNotes);
 } catch (error) {
   // Something went wrong, so delete the local and remote tag and bail.
   console.error(error);