feat: unify release steps

2026-03-04 07:25:54 +01:00
parent 9f2e1b512b
commit 40d0464f61
3 changed files with 341 additions and 351 deletions
--- a/flake.nix
+++ b/flake.nix
@@ -122,8 +122,7 @@
                ${pre-commit-check.shellHook}

                if [ -t 1 ]; then
-                  :
-                  # command -v tput >/dev/null 2>&1 && tput clear || printf '\033c'
+                  command -v tput >/dev/null 2>&1 && tput clear || printf '\033c'
                fi

                GREEN='\033[1;32m'
@@ -151,27 +150,13 @@
            #   line 2: CHANNEL (stable|alpha|beta|rc|internal|...)
            #   line 3: N (prerelease number, 0 for stable)
            postVersion ? "",
-            # Shell string — runs after VERSION + versionFiles are written, before git add.
+            # Shell string — runs after VERSION + release steps are written/run, before git add.
            # Same env vars available.
-            versionFiles ? [ ],
-            # List of { path, template } attrsets.
-            # template is a Nix function: version -> string
-            # The content is fully rendered by Nix at eval time — no shell interpolation needed.
-            # Example:
-            #   versionFiles = [
-            #     {
-            #       path = "src/version.ts";
-            #       template = version: ''export const APP_VERSION = "${version}" as const;'';
-            #     }
-            #     {
-            #       path = "internal/version/version.go";
-            #       template = version: ''
-            #         package version
-            #
-            #         const Version = "${version}"
-            #       '';
-            #     }
-            #   ];
+            release ? [ ],
+            # Unified list processed in declaration order:
+            #   { file = "path/to/file"; content = ''...$FULL_VERSION...''; }  # write file
+            #   { run = ''...shell snippet...''; }                               # run script
+            # Runtime env includes: BASE_VERSION, CHANNEL, PRERELEASE_NUM, FULL_VERSION, FULL_TAG.
            channels ? [
              "alpha"
              "beta"
@@ -186,35 +171,34 @@
            pkgs = import nixpkgs { inherit system; };
            channelList = pkgs.lib.concatStringsSep " " channels;

-            # Version files are fully rendered by Nix at eval time.
-            # The shell only writes the pre-computed strings — no shell interpolation in templates.
-            versionFilesScript = pkgs.lib.concatMapStrings (
-              f:
-              let
-                # We can't call f.template here since FULL_VERSION is a runtime value.
-                # Instead we pass the path and use a shell heredoc with the template
-                # rendered at runtime via the VERSION env vars.
-                renderedContent = f.template "$FULL_VERSION";
-              in
+            releaseStepsScript = pkgs.lib.concatMapStrings (
+              entry:
+              if entry ? file then
                ''
-                mkdir -p "$(dirname "${f.path}")"
-                cat > "${f.path}" << 'NIXEOF'
-                ${renderedContent}
+                  mkdir -p "$(dirname "${entry.file}")"
+                  cat > "${entry.file}" << NIXEOF
+                  ${entry.content}
                  NIXEOF
-                log "Generated version file: ${f.path}"
+                  log "Generated version file: ${entry.file}"
                ''
-            ) versionFiles;
+              else if entry ? run then
+                ''
+                  ${entry.run}
+                ''
+              else
+                builtins.throw "release entry must have either 'file' or 'run'"
+            ) release;

            script =
              builtins.replaceStrings
                [
                  "__CHANNEL_LIST__"
-                  "__VERSION_FILES__"
+                  "__RELEASE_STEPS__"
                  "__POST_VERSION__"
                ]
                [
                  channelList
-                  versionFilesScript
+                  releaseStepsScript
                  postVersion
                ]
                (builtins.readFile ./packages/release/release.sh);
@@ -237,18 +221,20 @@
      };

      # ── packages ────────────────────────────────────────────────────────────
-      packages = forAllSystems (
-        system:
-        let
-          pkgs = import nixpkgs { inherit system; };
-        in
-        {
+      packages = forAllSystems (system: {
        # Expose a no-op release package for the lib repo itself (dogfood)
        release = self.lib.mkRelease {
          inherit system;
-          };
+          release = [
+            {
+              run = ''
+                sed -E -i "s#^([[:space:]]*devshell-lib\\.url = \")git\\+https://git\\.dgren\\.dev/eric/nix-flake-lib[^"]*(\";)#\\1git+https://git.dgren.dev/eric/nix-flake-lib?ref=$FULL_TAG\\2#" "$ROOT_DIR/template/flake.nix"
+                log "Updated template/flake.nix devshell-lib ref to $FULL_TAG"
+              '';
            }
-      );
+          ];
+        };
+      });

      # ── devShells ───────────────────────────────────────────────────────────
      devShells = forAllSystems (
--- a/packages/release/release.nix
+++ b/packages/release/release.nix
@@ -1,13 +1,11 @@
 # release.nix
 {
  pkgs,
-  # Source of truth is always $ROOT_DIR/VERSION.
-  # Format:
-  #   line 1: X.Y.Z
-  #   line 2: CHANNEL (stable|alpha|beta|rc|internal|...)
-  #   line 3: N (prerelease number, 0 for stable)
  postVersion ? "",
-  versionFiles ? [ ],
+  release ? [ ],
+  # Unified list, processed in declaration order:
+  #   { file = "path/to/file"; content = "..."; }   — write file
+  #   { run = "shell snippet..."; }                  — run script
  channels ? [
    "alpha"
    "beta"
@@ -19,24 +17,28 @@
 let
  channelList = pkgs.lib.concatStringsSep " " channels;

-  versionFilesScript = pkgs.lib.concatMapStrings (f: ''
-    mkdir -p "$(dirname "${f.path}")"
-    ${f.content} > "${f.path}"
-    log "Generated version file: ${f.path}"
-  '') versionFiles;
+  releaseScript = pkgs.lib.concatMapStrings (
+    entry:
+    if entry ? file then
+      ''
+        mkdir -p "$(dirname "${entry.file}")"
+        cat > "${entry.file}" << NIXEOF
+        ${entry.content}
+        NIXEOF
+        log "Generated version file: ${entry.file}"
+      ''
+    else if entry ? run then
+      ''
+        ${entry.run}
+      ''
+    else
+      builtins.throw "release entry must have either 'file' or 'run'"
+  ) release;

  script =
    builtins.replaceStrings
-      [
-        "__CHANNEL_LIST__"
-        "__VERSION_FILES__"
-        "__POST_VERSION__"
-      ]
-      [
-        channelList
-        versionFilesScript
-        postVersion
-      ]
+      [ "__CHANNEL_LIST__" "__RELEASE_STEPS__" "__POST_VERSION__" ]
+      [ channelList releaseScript postVersion ]
      (builtins.readFile ./release.sh);
 in
 pkgs.writeShellApplication {
--- a/packages/release/release.sh
+++ b/packages/release/release.sh
@@ -159,7 +159,8 @@ compute_full_version() {
 	else
 		FULL_VERSION="${BASE_VERSION}-${CHANNEL}.${PRERELEASE_NUM:-1}"
 	fi
-  export BASE_VERSION CHANNEL PRERELEASE_NUM FULL_VERSION
+	FULL_TAG="v$FULL_VERSION"
+	export BASE_VERSION CHANNEL PRERELEASE_NUM FULL_VERSION FULL_TAG
 }

 # ── gitlint ────────────────────────────────────────────────────────────────
@@ -187,9 +188,9 @@ validate_commit_message() {

 # ── version file generation ────────────────────────────────────────────────

-generate_version_files() {
+run_release_steps() {
 	:
-  __VERSION_FILES__
+	__RELEASE_STEPS__
 }

 # ── version source (built-in) ──────────────────────────────────────────────
@@ -227,7 +228,7 @@ init_version_file() {
 		n_to_write="0"
 	fi

-  printf '%s\n%s\n%s\n' "$BASE_VERSION" "$channel_to_write" "$n_to_write" > "$ROOT_DIR/VERSION"
+	printf '%s\n%s\n%s\n' "$BASE_VERSION" "$channel_to_write" "$n_to_write" >"$ROOT_DIR/VERSION"
 	log "Initialized $ROOT_DIR/VERSION from highest tag: v$highest_tag"
 }

@@ -251,7 +252,7 @@ do_write_version() {
 		channel_to_write="stable"
 		n_to_write="0"
 	fi
-  printf '%s\n%s\n%s\n' "$BASE_VERSION" "$channel_to_write" "$n_to_write" > "$ROOT_DIR/VERSION"
+	printf '%s\n%s\n%s\n' "$BASE_VERSION" "$channel_to_write" "$n_to_write" >"$ROOT_DIR/VERSION"
 }

 # ── user-provided hook ─────────────────────────────────────────────────────
@@ -364,7 +365,8 @@ main() {
 	do_write_version
 	log "Updated version source"

-  generate_version_files
+	run_release_steps
+	log "Release steps done"

 	do_post_version
 	log "Post-version hook done"
@@ -378,13 +380,13 @@ main() {
 	git commit -m "$commit_msg"
 	log "Created commit"

-  git tag "v$FULL_VERSION"
-  CREATED_TAG="v$FULL_VERSION"
-  log "Tagged v$FULL_VERSION"
+	git tag "$FULL_TAG"
+	CREATED_TAG="$FULL_TAG"
+	log "Tagged $FULL_TAG"

 	git push
 	git push --tags
-  log "Done — released v$FULL_VERSION"
+	log "Done — released $FULL_TAG"

 	trap - ERR
 }