mirror of
https://github.com/Ark0N/Codeman.git
synced 2026-10-10 09:19:42 +02:00
Codeman maintainer
7689a43782
npm takes the package's readme from an unsorted {README,README.*} glob at
publish time, and with README.zh-CN.md beside README.md it kept picking the
Chinese one, so npmjs.com rendered it. `npm run release` now runs
scripts/npm-release.mjs, which moves README.zh-CN.md to a dot-name for the
length of `changeset publish` and always puts it back (also on a failed or
thrown publish, and after an interrupted earlier run). It lives in the publish
command, not in release.yml, because changesets/action commits the working
tree into its version PR. Verified with npm's own normalize: README.zh-CN.md
before, README.md with the file aside, and the aside copy is never packed.
package.json: the description names the CLIs and says self-hosted (the old
"run 20 autonomous agents" was an internal performance target), and homepage
points at getcodeman.com instead of repeating the repository link.
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
72 lines
3.0 KiB
JavaScript
72 lines
3.0 KiB
JavaScript
#!/usr/bin/env node
|
|
/**
|
|
* @fileoverview `npm run release`: `changeset publish` with `README.zh-CN.md` moved aside.
|
|
*
|
|
* npmjs.com renders the package's top-level `readme`, and npm picks it at publish time:
|
|
* @npmcli/package-json's normalize globs `{README,README.*}` in the package root UNSORTED and
|
|
* keeps the first `.md` it sees. With `README.zh-CN.md` next to `README.md` that was the
|
|
* Chinese one on this machine and on CI, so npmjs.com showed the Chinese README for months.
|
|
* `files` cannot help: npm-packlist always includes every root `README.*`.
|
|
*
|
|
* Renaming the file would break every link to it, so for the length of the publish only it
|
|
* moves to a name npm does not treat as a readme (a leading dot), and is put back afterwards,
|
|
* whatever the publish did. The move happens HERE, inside the publish command, never as a
|
|
* step before `changesets/action` in release.yml: that action also runs the version path and
|
|
* commits the working tree into its version PR, which would commit the deletion.
|
|
*
|
|
* A previous run killed between the move and the restore leaves the aside copy behind; the
|
|
* next run puts it back first. `xterm-zerolag-input` (packages/) has only a README.md.
|
|
*
|
|
* node scripts/npm-release.mjs what the Release workflow runs (via `npm run release`)
|
|
*/
|
|
import { existsSync, renameSync } from 'node:fs';
|
|
import { spawnSync } from 'node:child_process';
|
|
import { join } from 'node:path';
|
|
import { fileURLToPath } from 'node:url';
|
|
|
|
export const HIDDEN_README = 'README.zh-CN.md';
|
|
export const ASIDE_NAME = '.README.zh-CN.md.release-aside';
|
|
|
|
/**
|
|
* Runs `publish` with `HIDDEN_README` moved aside in `root`, restoring it afterwards, also
|
|
* when `publish` fails or throws. Returns the exit code `publish` returned.
|
|
*
|
|
* @param {{ root: string, publish: () => number, log?: (msg: string) => void }} opts
|
|
* @returns {number}
|
|
*/
|
|
export function publishWithReadmeAside({ root, publish, log = (msg) => console.log(msg) }) {
|
|
const original = join(root, HIDDEN_README);
|
|
const aside = join(root, ASIDE_NAME);
|
|
if (existsSync(aside) && !existsSync(original)) {
|
|
renameSync(aside, original);
|
|
log(`npm-release: restored ${HIDDEN_README} left aside by an earlier run`);
|
|
}
|
|
const moved = existsSync(original);
|
|
if (moved) {
|
|
renameSync(original, aside);
|
|
log(`npm-release: ${HIDDEN_README} moved aside so npm picks README.md as the readme`);
|
|
}
|
|
try {
|
|
return publish();
|
|
} finally {
|
|
if (moved) {
|
|
renameSync(aside, original);
|
|
log(`npm-release: ${HIDDEN_README} restored`);
|
|
}
|
|
}
|
|
}
|
|
|
|
function runChangesetPublish() {
|
|
const result = spawnSync('changeset', ['publish'], { stdio: 'inherit', shell: process.platform === 'win32' });
|
|
if (result.error) {
|
|
console.error(`npm-release: could not run changeset publish: ${result.error.message}`);
|
|
return 1;
|
|
}
|
|
return result.status ?? 1;
|
|
}
|
|
|
|
if (process.argv[1] && fileURLToPath(import.meta.url) === process.argv[1]) {
|
|
const root = join(fileURLToPath(new URL('.', import.meta.url)), '..');
|
|
process.exitCode = publishWithReadmeAside({ root, publish: runChangesetPublish });
|
|
}
|