Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .claude-plugin/marketplace.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
{
"name": "lvbt-contributions",
"description": "Create readable LVBT GitHub issues and pull requests.",
"version": "0.5.0",
"version": "0.5.1",
"source": "./packages/cli/plugins/lvbt-contributions"
}
]
Expand Down
15 changes: 15 additions & 0 deletions docs/reference/release-0-5-1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Repository tooling 0.5.1

Nothing changes in how your repository works. This patch fixes the maintainer script that gives a
repository its first `Standard update` workflow, and makes a missing `workflow_dispatch` trigger
easy to spot.

- Rerunning `standards/propose.ts` from a checkout still on the update branch no longer closes that
branch's own pull request. An unchanged run now closes a same-release pull request only when the
default branch on GitHub already vendors the release.
- A tracking ref left from an update branch GitHub has deleted no longer makes the next push fail.
- When `ci.yml` has no `workflow_dispatch` trigger, the `Standard update` run now says so and fails
after opening its pull request, instead of stopping with an unexplained error.

This is a patch release, so its update pull request merges itself once `Validate` passes. It is the
first release to reach repositories through their own `Standard update` workflow.
2 changes: 1 addition & 1 deletion examples/basic/.claude/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"source": {
"source": "github",
"repo": "LasVegasForTransit/repository-tooling",
"ref": "v0.5.0"
"ref": "v0.5.1"
}
}
},
Expand Down
4 changes: 2 additions & 2 deletions examples/basic/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
"*": "prettier --write --ignore-unknown"
},
"devDependencies": {
"@lasvegasfortransit/cli": "0.5.0",
"@lasvegasfortransit/prettier-config": "0.5.0",
"@lasvegasfortransit/cli": "0.5.1",
"@lasvegasfortransit/prettier-config": "0.5.1",
"lint-staged": "catalog:",
"markdownlint-cli2": "catalog:",
"markdownlint-rule-relative-links": "catalog:",
Expand Down
6 changes: 3 additions & 3 deletions examples/basic/packages/example/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@
"test": "vitest run"
},
"devDependencies": {
"@lasvegasfortransit/eslint-config": "0.5.0",
"@lasvegasfortransit/typescript-config": "0.5.0",
"@lasvegasfortransit/vitest-config": "0.5.0",
"@lasvegasfortransit/eslint-config": "0.5.1",
"@lasvegasfortransit/typescript-config": "0.5.1",
"@lasvegasfortransit/vitest-config": "0.5.1",
"@types/node": "catalog:",
"eslint": "catalog:",
"typescript": "catalog:",
Expand Down
2 changes: 1 addition & 1 deletion examples/with-astro/.claude/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"source": {
"source": "github",
"repo": "LasVegasForTransit/repository-tooling",
"ref": "v0.5.0"
"ref": "v0.5.1"
}
}
},
Expand Down
8 changes: 4 additions & 4 deletions examples/with-astro/apps/site/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@
},
"devDependencies": {
"@astrojs/check": "catalog:",
"@lasvegasfortransit/eslint-config": "0.5.0",
"@lasvegasfortransit/playwright-config": "0.5.0",
"@lasvegasfortransit/typescript-config": "0.5.0",
"@lasvegasfortransit/vitest-config": "0.5.0",
"@lasvegasfortransit/eslint-config": "0.5.1",
"@lasvegasfortransit/playwright-config": "0.5.1",
"@lasvegasfortransit/typescript-config": "0.5.1",
"@lasvegasfortransit/vitest-config": "0.5.1",
"@playwright/test": "catalog:",
"@types/node": "catalog:",
"eslint": "catalog:",
Expand Down
4 changes: 2 additions & 2 deletions examples/with-astro/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@
"*": "prettier --write --ignore-unknown"
},
"devDependencies": {
"@lasvegasfortransit/cli": "0.5.0",
"@lasvegasfortransit/prettier-config": "0.5.0",
"@lasvegasfortransit/cli": "0.5.1",
"@lasvegasfortransit/prettier-config": "0.5.1",
"lint-staged": "catalog:",
"markdownlint-cli2": "catalog:",
"markdownlint-rule-relative-links": "catalog:",
Expand Down
2 changes: 1 addition & 1 deletion examples/with-vite-react/.claude/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"source": {
"source": "github",
"repo": "LasVegasForTransit/repository-tooling",
"ref": "v0.5.0"
"ref": "v0.5.1"
}
}
},
Expand Down
8 changes: 4 additions & 4 deletions examples/with-vite-react/apps/app/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@
"react-dom": "catalog:"
},
"devDependencies": {
"@lasvegasfortransit/eslint-config": "0.5.0",
"@lasvegasfortransit/playwright-config": "0.5.0",
"@lasvegasfortransit/typescript-config": "0.5.0",
"@lasvegasfortransit/vitest-config": "0.5.0",
"@lasvegasfortransit/eslint-config": "0.5.1",
"@lasvegasfortransit/playwright-config": "0.5.1",
"@lasvegasfortransit/typescript-config": "0.5.1",
"@lasvegasfortransit/vitest-config": "0.5.1",
"@playwright/test": "catalog:",
"@tailwindcss/vite": "catalog:",
"@types/node": "catalog:",
Expand Down
4 changes: 2 additions & 2 deletions examples/with-vite-react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@
"*": "prettier --write --ignore-unknown"
},
"devDependencies": {
"@lasvegasfortransit/cli": "0.5.0",
"@lasvegasfortransit/prettier-config": "0.5.0",
"@lasvegasfortransit/cli": "0.5.1",
"@lasvegasfortransit/prettier-config": "0.5.1",
"lint-staged": "catalog:",
"markdownlint-cli2": "catalog:",
"markdownlint-rule-relative-links": "catalog:",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "lvbt-repository-tooling",
"private": true,
"version": "0.5.0",
"version": "0.5.1",
"type": "module",
"description": "Source of truth for the LVBT repository standard: the shared @lasvegasfortransit packages and the example repositories create-turbo copies.",
"packageManager": "pnpm@11.25.0",
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@lasvegasfortransit/cli",
"version": "0.5.0",
"version": "0.5.1",
"description": "The lvbt command every LVBT repository runs for bootstrap, preflight, and deploy, plus the production platform setup, the shared git hooks, and the lvbt-contributions agent plugin.",
"license": "MIT",
"type": "module",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "lvbt-contributions",
"version": "0.5.0",
"version": "0.5.1",
"description": "Create readable LVBT GitHub issues and pull requests through the organization workflow.",
"author": {
"name": "Las Vegans for Better Transit",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "lvbt-contributions",
"version": "0.5.0",
"version": "0.5.1",
"description": "Create readable LVBT GitHub issues and pull requests through the organization workflow.",
"author": {
"name": "Las Vegans for Better Transit",
Expand Down
2 changes: 1 addition & 1 deletion packages/eslint-config/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@lasvegasfortransit/eslint-config",
"version": "0.5.0",
"version": "0.5.1",
"description": "The ESLint configurations every LVBT repository uses.",
"license": "MIT",
"type": "module",
Expand Down
2 changes: 1 addition & 1 deletion packages/playwright-config/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@lasvegasfortransit/playwright-config",
"version": "0.5.0",
"version": "0.5.1",
"description": "The Playwright configuration every LVBT repository spreads into its own: end-to-end tests under tests/e2e, desktop and mobile projects, traces on failure.",
"license": "MIT",
"type": "module",
Expand Down
2 changes: 1 addition & 1 deletion packages/prettier-config/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@lasvegasfortransit/prettier-config",
"version": "0.5.0",
"version": "0.5.1",
"description": "The Prettier configuration every LVBT repository uses.",
"license": "MIT",
"type": "module",
Expand Down
2 changes: 1 addition & 1 deletion packages/typescript-config/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@lasvegasfortransit/typescript-config",
"version": "0.5.0",
"version": "0.5.1",
"description": "TypeScript configurations every LVBT repository extends.",
"license": "MIT",
"repository": {
Expand Down
2 changes: 1 addition & 1 deletion packages/vitest-config/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@lasvegasfortransit/vitest-config",
"version": "0.5.0",
"version": "0.5.1",
"description": "The Vitest configuration every LVBT repository spreads into its own.",
"license": "MIT",
"type": "module",
Expand Down
2 changes: 1 addition & 1 deletion packages/web-platform/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@lasvegasfortransit/web-platform",
"version": "0.5.0",
"version": "0.5.1",
"description": "Provider-neutral deployment, provisioning, and validation primitives for LVBT web repositories.",
"license": "MIT",
"type": "module",
Expand Down
40 changes: 37 additions & 3 deletions standards/propose.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,12 @@ function remoteBranchState(
branch: string,
runner: Runner,
): 'absent' | 'current' | 'stale' | 'edited' {
if (!runner('git', ['ls-remote', '--heads', 'origin', branch], target)) return 'absent';
if (!runner('git', ['ls-remote', '--heads', 'origin', branch], target)) {
// A tracking ref left from a branch GitHub has since deleted would make --force-with-lease
// refuse the push, so forget it.
runner('git', ['update-ref', '-d', `refs/remotes/origin/${branch}`], target);
return 'absent';
}
runner(
'git',
['fetch', '--quiet', 'origin', `+refs/heads/${branch}:refs/remotes/origin/${branch}`],
Expand Down Expand Up @@ -136,6 +141,33 @@ function createOrEdit(options: {
return (JSON.parse(runner('node', args, target)) as { number: number }).number;
}

/** The release the repository's default branch vendors, read from GitHub rather than the checkout. */
function defaultBranchRelease(target: string, runner: Runner): string | null {
const manifest = runner(
'gh',
[
'api',
'repos/{owner}/{repo}/contents/.lvbt/web-platform.json',
'-H',
'Accept: application/vnd.github.raw',
],
target,
);
return (JSON.parse(manifest) as { release: string | null }).release;
}

/** Runs Validate on the update branch; a workflow token's push alone starts no workflow. */
function dispatchValidation(target: string, branch: string, runner: Runner): void {
try {
runner('gh', ['workflow', 'run', 'ci.yml', '--ref', branch], target);
} catch {
process.stderr.write(
`Could not run ci.yml on ${branch}. Give ci.yml a workflow_dispatch trigger, as the examples' has, so update pull requests get their Validate check.\n`,
);
process.exitCode = 1;
}
}

/**
* Pushes the update branch, opens or refreshes its pull request, enables auto-merge, and closes
* update pull requests for older releases.
Expand Down Expand Up @@ -166,8 +198,10 @@ export async function proposeRelease(options: {
if (automerge) runner('gh', ['pr', 'merge', String(number), '--auto', '--rebase'], target);
// A push made with a repository's own GITHUB_TOKEN starts no workflow, but a dispatch always
// does, and its Validate check lands on the branch's head commit.
if (pushed) runner('gh', ['workflow', 'run', 'ci.yml', '--ref', updateBranch(tag)], target);
} else {
if (pushed) dispatchValidation(target, updateBranch(tag), runner);
} else if (defaultBranchRelease(target, runner) === tag) {
// Only a default branch that already carries the release makes its update pull request moot;
// a checkout that happens to be on the update branch does not.
superseded.push(...open.filter(({ headRefName }) => headRefName === updateBranch(tag)));
}

Expand Down
79 changes: 79 additions & 0 deletions tests/propose.test.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
import assert from 'node:assert/strict';
import test from 'node:test';

import { proposeRelease } from '../standards/propose.ts';

const entry = { name: 'example', requiredStatus: 'Validate', kind: 'consumer' };

/** A runner that records every command and answers from a table of canned outputs. */
function fakeRunner(answers) {
const calls = [];
const runner = (command, args) => {
const line = [command, ...args].join(' ');
calls.push(line);
for (const [pattern, answer] of answers) {
if (!pattern.test(line)) continue;
if (answer instanceof Error) throw answer;
return answer;
}
return '';
};
return { calls, runner };
}

const options = (runner, overrides = {}) => ({
source: '/nonexistent/source',
tooling: '/nonexistent/tooling',
target: '/nonexistent/target',
entry,
tag: 'v0.5.0',
changed: false,
from: 'v0.4.5',
runner,
...overrides,
});

const openUpdate = JSON.stringify([
{ number: 7, headRefName: 'automation/repository-standard-v0.5.0' },
]);

test('an unchanged checkout closes its update only when the default branch has the release', async () => {
const behind = fakeRunner([
[/^gh pr list --state open/, openUpdate],
[/web-platform\.json/, JSON.stringify({ release: 'v0.4.5' })],
]);
await proposeRelease(options(behind.runner));
assert.ok(!behind.calls.some((call) => call.startsWith('gh pr close')));

const current = fakeRunner([
[/^gh pr list --state open/, openUpdate],
[/web-platform\.json/, JSON.stringify({ release: 'v0.5.0' })],
]);
await proposeRelease(options(current.runner));
assert.ok(current.calls.some((call) => call.startsWith('gh pr close 7')));
});

test('a branch GitHub deleted is pushed afresh and a failed dispatch is reported, not thrown', async (t) => {
const exitCode = process.exitCode;
t.after(() => {
process.exitCode = exitCode;
});
const { calls, runner } = fakeRunner([
[/^gh pr list --state open/, '[]'],
[/^git ls-remote --heads/, ''],
[/^gh pr list --head/, JSON.stringify([{ number: 12 }])],
[/^gh workflow run ci\.yml/, new Error('no workflow_dispatch trigger')],
]);
const outcome = await proposeRelease(
options(runner, { changed: true, from: 'v0.5.0', tag: 'v0.5.1' }),
);
assert.equal(outcome, 'example: #12');
const forget = calls.findIndex((call) => call.startsWith('git update-ref -d'));
const push = calls.findIndex((call) => call.startsWith('git push --force-with-lease'));
assert.ok(forget !== -1 && forget < push, 'the stale tracking ref is forgotten before the push');
assert.ok(
calls.some((call) => call === 'gh pr merge 12 --auto --rebase'),
'a patch merges itself',
);
assert.equal(process.exitCode, 1);
});
Loading