@vzn/vx-ci 0.0.633 → 0.0.635

package/README.md

@@ -1,6 +1,8 @@
 # @vzn/vx-ci
 
-GitHub Actions integration for [`@vzn/vx`](https://github.com/vznjs/vx) — a
+Website: <https://vznjs.github.io/vx/> · this plugin: <https://vznjs.github.io/vx/plugins/vx-ci/> · source: <https://github.com/vznjs/vx>
+
+GitHub Actions integration for [`@vzn/vx`](https://vznjs.github.io/vx/) — a
 telemetry plugin that writes every `vx run` as a **job summary** on the
 workflow run page.
 
@@ -29,8 +31,9 @@ that never became ready as `never ready (timed out)`, a sandboxed task's
 violation count, and the tasks each failure blocked. A footer line
 names the vx version, the command (what follows `--` counted, not
 quoted), tasks passed and outputs restored.
-Anywhere else — laptops, other CI — the plugin **declines** and costs
-nothing, so declaring it unconditionally is safe.
+Anywhere else (`GITHUB_ACTIONS` not `true`: laptops, other CI)
+`github()` returns `undefined`, which `plugins` skips: no option is
+checked and nothing loads, so declaring it unconditionally is safe.
 
 ## Options
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vzn/vx-ci",
-  "version": "0.0.633",
+  "version": "0.0.635",
   "license": "MIT",
   "description": "GitHub Actions integration for vx — a telemetry plugin that writes the run as a GitHub Actions job summary.",
   "keywords": [
@@ -33,7 +33,7 @@
     "access": "public"
   },
   "peerDependencies": {
-    "@vzn/vx": "^0.0.633"
+    "@vzn/vx": "^0.0.635"
   },
   "repository": {
     "type": "git",

package/src/plugin.ts

@@ -1,8 +1,8 @@
 // The `github()` telemetry plugin. Contributes one observe-only sink that
-// writes the run as a GitHub Actions job summary. Declines (returns
-// undefined) outside GitHub Actions — no `GITHUB_STEP_SUMMARY` file to write
-// and no cost — so declaring `github()` is safe in every environment, the
-// same decline pattern as `otel()`.
+// writes the run as a GitHub Actions job summary. Off Actions
+// (`GITHUB_ACTIONS` not 'true') the factory returns undefined, which
+// `plugins` skips: no option check, no hook, no load, so declaring
+// `github()` costs nothing on a laptop.
 import { appendFile, stat } from 'node:fs/promises'
 import { createRequire } from 'node:module'
 import {
@@ -83,7 +83,8 @@ const GITHUB_PLUGIN_KEYS: PluginOptionKinds<GithubPluginOptions> = {
   sizeOf: 'function',
 }
 
-export function github(options: GithubPluginOptions = {}): VxPlugin {
+export function github(options: GithubPluginOptions = {}): VxPlugin | undefined {
+  if (process.env['GITHUB_ACTIONS'] !== 'true') return undefined
   refuseUnknownOptions('github()', options, GITHUB_PLUGIN_KEYS)
   // '' passes the kind check but reads wrong: `??` keeps it, so summaryFile
   // declined instead of using GITHUB_STEP_SUMMARY, checkName POSTed a name