feat: Support info and version file in rules_task (#652)

.bazelrc

@@ -11,6 +11,8 @@ query:quiet --ui_event_filters=-info --noshow_progress
 # Disable the bazel symlinks
 common --experimental_convenience_symlinks=ignore
 
+common --workspace_status_command=tools/bazel/workspace_status.sh
+
 # Print warning messages about test suite being configured as too small/big
 test --test_verbose_timeout_warnings
 

.changeset/bunq2ynab-purple-windows-swim.md

@@ -0,0 +1,5 @@
+---
+"bunq2ynab": patch
+---
+
+chore(deps): Upgrade bazel_skylib and bazel_skylib

.changeset/provisioner-soft-tables-bake.md

@@ -0,0 +1,5 @@
+---
+"provisioner": patch
+---
+
+chore(deps): Upgrade bazel_skylib and bazel_skylib

.changeset/rules_release-thirty-kiwis-attack.md

@@ -0,0 +1,5 @@
+---
+"rules_release": patch
+---
+
+chore(deps): Upgrade bazel_skylib and bazel_skylib

.changeset/rules_task-old-apples-sneeze-2.md

@@ -0,0 +1,5 @@
+---
+"rules_task": patch
+---
+
+chore(deps): Upgrade bazel_skylib and bazel_skylib

.changeset/rules_task-old-apples-sneeze.md

@@ -0,0 +1,5 @@
+---
+"rules_task": minor
+---
+
+feat: Support loading version file and info file into tasks

MODULE.bazel

@@ -23,13 +23,13 @@ bazel_dep(
 # ------------------------------------ rules_skylib ------------------------------------ #
 bazel_dep(
     name = "bazel_skylib",
-    version = "1.4.2",
+    version = "1.5.0",
 )
 
 # ------------------------------------ aspect_bazel_lib ------------------------------------ #
 bazel_dep(
     name = "aspect_bazel_lib",
-    version = "2.0.3",
+    version = "2.5.0",
 )
 
 bazel_lib_toolchains = use_extension("@aspect_bazel_lib//lib:extensions.bzl", "toolchains")

rules/rules_release/BUILD.bazel

@@ -1,6 +1,6 @@
 load("@rules_task//task:defs.bzl", "cmd")
 load("//tools:defs.bzl", "publish_github_release", release = "release_changed_files")
-load("@aspect_bazel_lib//lib:tar.bzl", "mtree_spec", "tar")
+load("@aspect_bazel_lib//lib:tar.bzl", "tar")
 load("@npm//:defs.bzl", "npm_link_all_packages")
 
 npm_link_all_packages()
@@ -48,36 +48,13 @@ filegroup(
     ],
 )
 
-mtree_spec(
-    name = "release_archive_mtree",
-    srcs = [
-        ":all_files",
-    ],
-)
-
-# Remove `../rules_release~override` from each line because otherwise
-# this results in an empty archive when extracting.
-genrule(
-    name = "release_archive_mtree_normalized",
-    srcs = [
-        ":release_archive_mtree",
-    ],
-    outs = [
-        "release_archive_mtree_normalized.spec",
-    ],
-    cmd = """
-    sed 's|../{}/||' $< > $@
-    """.format(repository_name().removeprefix("@")),
-)
-
 tar(
     name = "release_archive",
     srcs = [
         ":all_files",
     ],
     out = "rules_release.tar.gz",
     compress = "gzip",
-    mtree = ":release_archive_mtree_normalized",
 )
 
 genrule(

rules/rules_release/MODULE.bazel

@@ -16,11 +16,11 @@ bazel_dep(name = "platforms", version = "0.0.8")
 # ------------------------------------ bazel_skylib ------------------------------------ #
 bazel_dep(
     name = "bazel_skylib",
-    version = "1.4.2",
+    version = "1.5.0",
 )
 
 # ------------------------------------ aspect_bazel_lib ------------------------------------ #
-bazel_dep(name = "aspect_bazel_lib", version = "2.0.3")
+bazel_dep(name = "aspect_bazel_lib", version = "2.5.0")
 
 # ------------------------------------ rules_java ------------------------------------ #
 bazel_dep(name = "rules_java", version = "7.0.6")

rules/rules_release/release/repositories.bzl

@@ -39,10 +39,10 @@ def rules_release_bazel_dependencies():
 
     http_archive(
         name = "bazel_skylib",
-        sha256 = "66ffd9315665bfaafc96b52278f57c7e2dd09f5ede279ea6d39b2be471e7e3aa",
+        sha256 = "cd55a062e763b9349921f0f5db8c3933288dc8ba4f76dd9416aac68acee3cb94",
         urls = [
-            "https://mirror.bazel.build/github.com/bazelbuild/bazel-skylib/releases/download/1.4.2/bazel-skylib-1.4.2.tar.gz",
-            "https://github.com/bazelbuild/bazel-skylib/releases/download/1.4.2/bazel-skylib-1.4.2.tar.gz",
+            "https://mirror.bazel.build/github.com/bazelbuild/bazel-skylib/releases/download/1.5.0/bazel-skylib-1.5.0.tar.gz",
+            "https://github.com/bazelbuild/bazel-skylib/releases/download/1.5.0/bazel-skylib-1.5.0.tar.gz",
         ],
     )
 

rules/rules_task/BUILD.bazel

@@ -1,5 +1,5 @@
 load("@rules_release//tools:defs.bzl", "publish_github_release", release = "release_changed_files")
-load("@aspect_bazel_lib//lib:tar.bzl", "mtree_spec", "tar")
+load("@aspect_bazel_lib//lib:tar.bzl", "tar")
 load("//task:defs.bzl", "cmd")
 load("//tools:defs.bzl", "compile_pip_requirements")
 
@@ -22,36 +22,13 @@ filegroup(
     ],
 )
 
-mtree_spec(
-    name = "release_archive_mtree",
-    srcs = [
-        ":all_files",
-    ],
-)
-
-# Remove `../rules_task~override` from each line because otherwise
-# this results in an empty archive when extracting.
-genrule(
-    name = "release_archive_mtree_normalized",
-    srcs = [
-        ":release_archive_mtree",
-    ],
-    outs = [
-        "release_archive_mtree_normalized.spec",
-    ],
-    cmd = """
-    sed 's|../{}/||' $< > $@
-    """.format(repository_name().removeprefix("@")),
-)
-
 tar(
     name = "release_archive",
     srcs = [
         ":all_files",
     ],
     out = "rules_task.tar.gz",
     compress = "gzip",
-    mtree = ":release_archive_mtree_normalized",
 )
 
 genrule(

rules/rules_task/MODULE.bazel

@@ -8,8 +8,8 @@ module(
     version = "0.0.0",
 )
 
-bazel_dep(name = "bazel_skylib", version = "1.4.2")
-bazel_dep(name = "aspect_bazel_lib", version = "1.36.0")
+bazel_dep(name = "bazel_skylib", version = "1.5.0")
+bazel_dep(name = "aspect_bazel_lib", version = "2.5.0")
 
 # ------------------------------------ rules_python ------------------------------------ #
 bazel_dep(name = "rules_python", version = "0.29.0")

rules/rules_task/README.md

@@ -125,7 +125,7 @@ You can use the `cmd.executable` AST node to reference other **executable** targ
 task(
     name = "executable",
     cmds = [
-        "$my_executable",
+        "$tool",
     ],
     env = {
         "tool": cmd.executable("my_executable"),
@@ -141,8 +141,8 @@ You can use the `cmd.file` and `cmd.files` AST nodes to reference other targets.
 task(
     name = "file",
     cmds = [
-        "echo $my_file",
-        "cat $my_file_group",
+        "echo $file",
+        "cat $files",
     ],
     env = {
         "file": cmd.file("my_file"),
@@ -151,6 +151,58 @@ task(
 )
 ```
 
+### Using variables from Bazel workspace_status_command / stamping
+
+If you add the following variable to the `workspace_status_command`:
+
+```bash
+#!/bin/bash
+echo "STABLE_SOME_VAR BAR"
+```
+
+Add add `stamp_stable` attribute to the `task` rule, you can use the variable in the task:
+
+```bazel
+task(
+    name = "stamp_stable",
+    cmds = [
+        "echo $STABLE_SOME_VAR",
+    ],
+    stamp_stable = True,
+)
+```
+
+This will print:
+
+```bash
+FOO
+```
+
+The same goes for volatile variables which has the benefit of not invalidating the Bazel cache if only the volatile variable changes ([docs](https://bazel.build/docs/user-manual#workspace-status)). With the following `workspace_status_command`:
+
+```bash
+#!/bin/bash
+echo "SOME_OTHER_VAR BAR"
+```
+
+And the `stamp_volatile` attribute:
+
+```bazel
+task(
+    name = "stamp_volatile",
+    cmds = [
+        "echo $SOME_OTHER_VAR",
+    ],
+    stamp_volatile = True,
+)
+```
+
+This will print:
+
+```bash
+BAR
+```
+
 ### More examples
 
 For more examples, see the [tests](tests/BUILD.bazel).
@@ -254,6 +306,36 @@ See [Referencing outputs of other targets](#referencing-outputs-of-other-targets
 
 See [Referencing outputs of other targets](#referencing-outputs-of-other-targets)
 
+### `cmd.version_file`
+
+Instead of using the `stamp_stable` and `stamp_volatile` flags, you can use the `cmd.version_file` node to reference the file containing the stable variables. Given a `workspace_status_command` like:
+
+```bash
+#!/bin/bash
+echo "VOLATILE_SOME_VAR BAR"
+```
+
+And running `cat` on the the version file
+
+```bazel
+task(
+    name = "version_file",
+    cmds = [
+        cmd.shell("cat", cmd.version_file()),
+    ],
+)
+```
+
+This will print
+
+```bash
+export VOLATILE_SOME_VAR='BAR'
+```
+
+### `cmd.info_file`
+
+This is the same as `cmd.version_file` but for the info file, this gives you the volatile variables.
+
 ### `cmd.executable`
 
 See [Using executable targets](#using-executable-targets)

rules/rules_task/task/private/BUILD.bazel

@@ -1,6 +1,13 @@
+load("@rules_python//python:defs.bzl", "py_binary")
+
 package(default_visibility = ["//visibility:public"])
 
 filegroup(
     name = "all_files",
     srcs = glob(["**/*"]),
 )
+
+py_binary(
+    name = "dotenv_convert",
+    srcs = ["dotenv_convert.py"],
+)

rules/rules_task/task/private/cmd.bzl

@@ -24,6 +24,12 @@ def _wrap_env(env):
             env[key] = cmd.string(value)
     return env
 
+def _wrap_env_file(node):
+    if type(node) == "string":
+        node = cmd.string(node)
+
+    return node
+
 def _wrap_shell_args(args):
     result = []
 
@@ -88,6 +94,10 @@ cmd = struct(
         "type": "env",
         "env": _wrap_env(env),
     },
+    env_file = lambda node: {
+        "type": "env_file",
+        "node": _wrap_env_file(node),
+    },
     defer = lambda node: {
         "type": "defer",
         "node": _wrap_defer(node),
@@ -100,6 +110,12 @@ cmd = struct(
         "type": "file",
         "label": fq_label(label),
     },
+    version_file = lambda: {
+        "type": "version_file",
+    },
+    info_file = lambda: {
+        "type": "info_file",
+    },
     files = lambda label: {
         "type": "files",
         "label": fq_label(label),

rules/rules_task/task/private/dotenv_convert.py

@@ -0,0 +1,25 @@
+import sys
+import shlex
+
+_, input_file, output_file = sys.argv
+
+with open(input_file, "r") as file:
+    bazel_content = file.read()
+
+results = []
+
+for line in bazel_content.split("\n"):
+    if not line:
+        continue
+
+    key, value = line.split(" ", 1)
+    safe_value = shlex.quote(value)
+
+    results.append(f"export {key}={safe_value}")
+
+with open(output_file, "w") as file:
+    file.write("\n".join(results))
+
+
+print(f"input_file: {input_file}")
+print(f"output_file: {output_file}")