Skip to content

Commit 1be1368

Browse files
committed
docs: record that this stack-breadcrumb copy is the authoritative one
The header said where the module came from and stopped there. Accurate: it did start as taskless/taskless's `@taskless/stack-breadcrumb` package. But the fact a reader needs is the other one — this copy is now authoritative, and taskless/taskless vendors it rather than maintaining its own. Without that, nothing here tells anyone that a change made in this file silently diverges a downstream copy, or that a fix made downstream is a fork the next sync discards. The cloud team hit exactly that: their CLAUDE.md credited the module to the wrong repository, and their copy's header claimed it had been "brought into this repository" from taskless/taskless — which is them, so the sentence had become self-referential when someone copied the header across. They corrected their end; this is ours. Also records why there is no drift test, since the obvious next question after "two copies exist" is "what checks they match". Nothing does, and deliberately: this repository moves ahead of the vendored copy by design, so a drift test would fail on precisely the changes that are supposed to happen. The stakes fit — a diverged breadcrumb renders a PR body slightly differently, where a diverged rule layout writes rules to the wrong place, which is why that one has a drift test and this one has a sentence. Applied to the module, its test, and the workflow, because all three carry the same origin note and a reader can arrive at any of them.
1 parent 088fa7c commit 1be1368

3 files changed

Lines changed: 23 additions & 0 deletions

File tree

‎.github/scripts/stack-breadcrumb.cjs‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22
// Adapted from the taskless/taskless stack-breadcrumb implementation
33
// (@taskless/stack-breadcrumb) and brought into this repository under its MIT
44
// license, with permission.
5+
//
6+
// THIS COPY IS THE AUTHORITATIVE ONE, and copies exist downstream: taskless/taskless
7+
// vendors it rather than maintaining its own. Fixes are made here and re-vendored
8+
// from here, so a change made downstream is a fork that the next sync discards.
9+
//
10+
// Nothing checks that the copies match, deliberately. This repository moves ahead
11+
// of the vendored copy by design, so a drift test would fail on exactly the changes
12+
// that are supposed to happen. The stakes suit that: a diverged breadcrumb renders a
13+
// PR body slightly differently, where a diverged rule layout writes rules to the
14+
// wrong place — which is why THAT one has a drift test and this one has a sentence.
515
"use strict";
616

717
/**

‎.github/scripts/stack-breadcrumb.test.cjs‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22
// Adapted from the taskless/taskless stack-breadcrumb implementation
33
// (@taskless/stack-breadcrumb) and brought into this repository under its MIT
44
// license, with permission.
5+
//
6+
// THIS COPY IS THE AUTHORITATIVE ONE, and copies exist downstream: taskless/taskless
7+
// vendors it rather than maintaining its own. Fixes are made here and re-vendored
8+
// from here, so a change made downstream is a fork that the next sync discards.
9+
//
10+
// Nothing checks that the copies match, deliberately. This repository moves ahead
11+
// of the vendored copy by design, so a drift test would fail on exactly the changes
12+
// that are supposed to happen. The stakes suit that: a diverged breadcrumb renders a
13+
// PR body slightly differently, where a diverged rule layout writes rules to the
14+
// wrong place — which is why THAT one has a drift test and this one has a sentence.
515
"use strict";
616

717
const test = require("node:test");

‎.github/workflows/stack-breadcrumb.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# SPDX-License-Identifier: MIT
22
# Adapted from the taskless/taskless stack-breadcrumb workflow and brought into
33
# this repository under its MIT license, with permission.
4+
#
5+
# Authoritative here; taskless/taskless vendors this workflow and the module it
6+
# loads. Fixes are made in this repository and re-vendored from it.
47
name: Stack Breadcrumb
58

69
# Self-contained stacked-PR breadcrumb. All logic lives in a zero-dependency

0 commit comments

Comments
 (0)