mirror of
https://github.com/Heretek-AI/awesome-opencode.git
synced 2026-11-07 10:45:57 -10:00
feat: issue-form submissions and npm run new scaffolder
The "Add an entry" issue form collects fields; issues.yml runs scripts/submit-entry.js, which validates and probes the entry, comments the result and opens a PR from submission/<issue> (updated on every issue edit). Contributors never write YAML or touch the README, the two most common rejection causes. npm run new writes a correctly formatted entry locally. Bot PRs dispatch the validate check because GITHUB_TOKEN pushes do not trigger workflows. Co-Authored-By: Claude Opus 5.5 <[email protected]>
This commit is contained in:
John SmithandClaude Opus 5.5 committed
1 parent
ef6357d8d1
commit
d23bb027f9
7 files changed
+587
-29
No files matched your search
@@ -0,0 +1,76 @@
|
||||
/**
|
||||
* Open or update a bot pull request from file changes (used by submissions, scout, health).
|
||||
*
|
||||
* Commits made with GITHUB_TOKEN do not trigger workflows, so after pushing, the "validate" workflow
|
||||
* is dispatched on the branch; its check run attaches to the head commit and satisfies the required
|
||||
* status check on the PR.
|
||||
*/
|
||||
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
const { execFileSync } = require('child_process');
|
||||
const { rest } = require('./github');
|
||||
const { REPO, addLabels } = require('./repo');
|
||||
|
||||
const ROOT = path.join(__dirname, '../..');
|
||||
const BOT = ['-c', 'user.name=github-actions[bot]', '-c', 'user.email=41898282+github-actions[bot]@users.noreply.github.com'];
|
||||
|
||||
const git = (...args) => execFileSync('git', args, { cwd: ROOT, encoding: 'utf8', stdio: ['ignore', 'pipe', 'pipe'] }).trim();
|
||||
|
||||
/**
|
||||
* @param {object} options
|
||||
* @param {string} options.branch - e.g. "submission/123"
|
||||
* @param {Object<string, string|null>} options.files - repo-relative path -> new content (null deletes)
|
||||
* @param {string} options.title
|
||||
* @param {string} options.body
|
||||
* @param {string[]} [options.labels]
|
||||
* @param {string} [options.base="main"]
|
||||
* @param {boolean} [options.dryRun]
|
||||
* @returns {Promise<{number: number, url: string, created: boolean}|null>} null when there is nothing to change
|
||||
*/
|
||||
async function openPullRequest({ branch, files, title, body, labels = [], base = 'main', dryRun = false }) {
|
||||
if (!/^[a-z0-9][a-z0-9/_.-]*$/i.test(branch)) throw new Error(`unsafe branch name: ${branch}`);
|
||||
const original = git('rev-parse', '--abbrev-ref', 'HEAD');
|
||||
git('fetch', '--quiet', 'origin', base);
|
||||
git('checkout', '--quiet', '-B', branch, `origin/${base}`);
|
||||
try {
|
||||
for (const [file, content] of Object.entries(files)) {
|
||||
const target = path.join(ROOT, file);
|
||||
if (!target.startsWith(path.join(ROOT, 'data') + path.sep)) throw new Error(`refusing to write outside data/: ${file}`);
|
||||
if (content === null) {
|
||||
if (fs.existsSync(target)) git('rm', '--quiet', '--', file);
|
||||
} else {
|
||||
fs.mkdirSync(path.dirname(target), { recursive: true });
|
||||
fs.writeFileSync(target, content);
|
||||
git('add', '--', file);
|
||||
}
|
||||
}
|
||||
if (!git('diff', '--cached', '--name-only')) return null;
|
||||
if (dryRun) {
|
||||
console.log(`[dry run] would push ${branch}: ${git('diff', '--cached', '--stat')}`);
|
||||
return null;
|
||||
}
|
||||
git(...BOT, 'commit', '--quiet', '-m', title);
|
||||
git('push', '--quiet', '--force', 'origin', `HEAD:refs/heads/${branch}`);
|
||||
} finally {
|
||||
git('checkout', '--quiet', '--force', original === 'HEAD' ? `origin/${base}` : original);
|
||||
}
|
||||
|
||||
const owner = REPO.split('/')[0];
|
||||
const { data: existing } = await rest(`/repos/${REPO}/pulls?state=open&head=${owner}:${encodeURIComponent(branch)}`);
|
||||
let pr;
|
||||
let created = false;
|
||||
if (Array.isArray(existing) && existing.length) {
|
||||
({ data: pr } = await rest(`/repos/${REPO}/pulls/${existing[0].number}`, { method: 'PATCH', body: { title, body } }));
|
||||
} else {
|
||||
const res = await rest(`/repos/${REPO}/pulls`, { method: 'POST', body: { title, body, head: branch, base } });
|
||||
if (res.status >= 300) throw new Error(`create PR for ${branch}: HTTP ${res.status} ${JSON.stringify(res.data).slice(0, 300)}`);
|
||||
pr = res.data;
|
||||
created = true;
|
||||
}
|
||||
if (labels.length) await addLabels(pr.number, labels);
|
||||
await rest(`/repos/${REPO}/actions/workflows/validate-pr.yml/dispatches`, { method: 'POST', body: { ref: branch } });
|
||||
return { number: pr.number, url: pr.html_url, created };
|
||||
}
|
||||
|
||||
module.exports = { openPullRequest };
|
||||
@@ -0,0 +1,139 @@
|
||||
/**
|
||||
* Build catalog entries from structured input (issue form, scout candidates, CLI scaffolder).
|
||||
*/
|
||||
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
const { CATEGORIES, DATA_DIR, canonicalKey, checkCatalog, loadCatalog, parseRepoUrl } = require('./catalog');
|
||||
const { probeCompat } = require('./compat');
|
||||
const { dumpEntry } = require('./format');
|
||||
const { slugify } = require('./yaml');
|
||||
|
||||
const ISSUE_FORM_FIELDS = {
|
||||
'Name': 'name',
|
||||
'Repository URL': 'repo',
|
||||
'Folder inside the repository': 'path',
|
||||
'npm package': 'npm',
|
||||
'Category': 'category',
|
||||
'Kind': 'kind',
|
||||
'Topics': 'topics',
|
||||
'Tagline': 'tagline',
|
||||
'Description': 'description',
|
||||
'Documentation URL': 'homepage',
|
||||
'Installation': 'installation'
|
||||
};
|
||||
|
||||
const EMPTY = /^(_no response_|none|n\/a|-)?$/i;
|
||||
|
||||
/**
|
||||
* Parse a GitHub issue form body ("### Label\n\nvalue" sections).
|
||||
* @param {string} body
|
||||
* @returns {object} raw fields keyed by ISSUE_FORM_FIELDS values
|
||||
*/
|
||||
function parseIssueForm(body) {
|
||||
const fields = {};
|
||||
const sections = String(body || '').split(/^###\s+/m).slice(1);
|
||||
for (const section of sections) {
|
||||
const [label, ...rest] = section.split('\n');
|
||||
const key = ISSUE_FORM_FIELDS[label.trim()];
|
||||
if (!key) continue;
|
||||
let value = rest.join('\n').trim();
|
||||
if (EMPTY.test(value)) continue;
|
||||
if (key === 'installation') value = value.replace(/^```\w*\n?|\n?```$/g, '').trim();
|
||||
fields[key] = value;
|
||||
}
|
||||
return fields;
|
||||
}
|
||||
|
||||
/**
|
||||
* Normalize raw input into entry data.
|
||||
* @param {object} input - { name, repo, path, npm, category, kind, topics, tagline, description, homepage, installation }
|
||||
* @returns {{category: string, data: object}}
|
||||
*/
|
||||
function normalizeInput(input) {
|
||||
const category = String(input.category || '').trim().toLowerCase();
|
||||
const topics = Array.isArray(input.topics)
|
||||
? input.topics
|
||||
: String(input.topics || '').split(/[,\n]/).map(t => t.trim().toLowerCase()).filter(Boolean);
|
||||
let repo = String(input.repo || '').trim().replace(/\.git$/, '').replace(/\/+$/, '');
|
||||
let repoPath = input.path ? String(input.path).trim().replace(/^\/+|\/+$/g, '') : undefined;
|
||||
// Accept a pasted /tree/<branch>/<folder> URL by splitting it into repo + path
|
||||
const tree = repo.match(/^(https:\/\/github\.com\/[^/]+\/[^/]+)\/tree\/[^/]+\/(.+)$/);
|
||||
if (tree) {
|
||||
repo = tree[1];
|
||||
repoPath = repoPath || tree[2];
|
||||
}
|
||||
const data = {
|
||||
name: input.name && String(input.name).trim(),
|
||||
repo,
|
||||
path: repoPath,
|
||||
npm: input.npm ? String(input.npm).trim().replace(/^https:\/\/www\.npmjs\.com\/package\//, '') : undefined,
|
||||
homepage: input.homepage ? String(input.homepage).trim() : undefined,
|
||||
tagline: input.tagline && String(input.tagline).trim(),
|
||||
description: input.description && String(input.description).trim(),
|
||||
kind: input.kind ? String(input.kind).trim().toLowerCase() : undefined,
|
||||
topics,
|
||||
compat: input.compat,
|
||||
installation: input.installation ? String(input.installation).trim() : undefined
|
||||
};
|
||||
return { category, data };
|
||||
}
|
||||
|
||||
/**
|
||||
* Pick a free filename: <repo-name>.yaml (or the monorepo folder name), then <owner>-<repo>.yaml.
|
||||
* @returns {string} path relative to the repository root
|
||||
*/
|
||||
function chooseFile(category, data, taken = new Set()) {
|
||||
const parsed = parseRepoUrl(data.repo) || { owner: 'entry', name: slugify(data.name || 'entry') };
|
||||
const base = slugify(data.path ? path.basename(data.path) : parsed.name) || slugify(data.name || 'entry');
|
||||
const candidates = [base, slugify(`${parsed.owner}-${base}`), slugify(`${base}-${data.name || ''}`)];
|
||||
for (const candidate of candidates) {
|
||||
const file = path.join('data', category, `${candidate}.yaml`);
|
||||
if (!taken.has(file) && !fs.existsSync(path.join(DATA_DIR, '..', file))) return file;
|
||||
}
|
||||
for (let i = 2; ; i++) {
|
||||
const file = path.join('data', category, `${base}-${i}.yaml`);
|
||||
if (!taken.has(file) && !fs.existsSync(path.join(DATA_DIR, '..', file))) return file;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Build, verify and serialize an entry.
|
||||
* @param {object} input - raw fields
|
||||
* @param {object} [options] - { probe: boolean }
|
||||
* @returns {Promise<{ok: boolean, problems: string[], notes: string[], category: string, file?: string, text?: string, data: object}>}
|
||||
*/
|
||||
async function buildEntry(input, { probe = true } = {}) {
|
||||
const { category, data } = normalizeInput(input);
|
||||
const problems = [];
|
||||
const notes = [];
|
||||
|
||||
if (!CATEGORIES.includes(category)) {
|
||||
problems.push(`category must be one of: ${CATEGORIES.join(', ')}`);
|
||||
return { ok: false, problems, notes, category, data };
|
||||
}
|
||||
if (category === 'plugins') data.kind = data.kind || 'plugin';
|
||||
if (category === 'themes') data.kind = data.kind || 'theme';
|
||||
|
||||
if (probe && data.repo && (category === 'plugins' || data.npm)) {
|
||||
const result = (await probeCompat([{ key: 'entry', repo: data.repo, path: data.path, npm: data.npm, plugin: category === 'plugins' }])).get('entry');
|
||||
data.compat = result.compat === 'unknown' && category !== 'plugins' ? 'n/a' : result.compat;
|
||||
notes.push(`V2 check: ${result.compat}${result.evidence.length ? ` (${result.evidence.join('; ')})` : ''}`);
|
||||
if (category === 'plugins' && result.compat === 'v1') {
|
||||
problems.push('this plugin targets the legacy V1 plugin API. New plugins must depend on @opencode/plugin and export Plugin.define({ id, setup(ctx) }). Edit this issue after migrating and the check runs again.');
|
||||
}
|
||||
} else if (category !== 'plugins') {
|
||||
data.compat = data.compat || 'n/a';
|
||||
}
|
||||
|
||||
const { entries } = loadCatalog();
|
||||
const file = chooseFile(category, data);
|
||||
const entry = { category, id: path.basename(file, '.yaml'), file, data };
|
||||
const duplicate = entries.find(e => e.data.repo && canonicalKey(e.data) === canonicalKey(data));
|
||||
if (duplicate) problems.push(`already in the catalog as ${duplicate.file}`);
|
||||
for (const problem of checkCatalog([entry])) problems.push(problem.message);
|
||||
|
||||
return { ok: problems.length === 0, problems, notes, category, file, text: dumpEntry(data), data };
|
||||
}
|
||||
|
||||
module.exports = { ISSUE_FORM_FIELDS, buildEntry, chooseFile, normalizeInput, parseIssueForm };
|
||||
Reference in new issue
Block a user