release-with-ease 2.0.2 → 2.1.0

package/.claude/settings.local.json

@@ -0,0 +1,10 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(git add:*)",
+      "Bash(git commit -m ':*)",
+      "Bash(git push:*)",
+      "Bash(gh pr:*)"
+    ]
+  }
+}

package/README.md

@@ -25,10 +25,23 @@ The script requires these environment variables to be set:
 
 You can get a key from https://console.anthropic.com/settings/keys.
 
-The script also assumes that your README.md file has a `# Changelog` section.
+The script also requires the `gh` CLI to be installed and authenticated (used to
+create GitHub releases).
+
+If your `README.md` has a `# Changelog` section, the script will automatically
+insert the release notes there. Otherwise it skips that step and relies solely on
+the GitHub release.
 
 # Changelog
 
+## 2.1.0
+
+- Support npm publish and GitHub releases for public npm packages [by @trotzig in #5]
+- Include PR number and author attribution in release notes for public packages [by @trotzig]
+- Auto-detect README.md changelog section; skip insertion if absent for better compatibility
+- Run `npm publish` automatically for packages without `private: true` in package.json
+- Create GitHub releases automatically via `gh release create` after every push (for public packages)
+
 ## 1.0.1
 
 - Fix path to README and package.json

package/bin/release-with-ease.js

@@ -74,18 +74,79 @@ function parseCommits(raw) {
     });
 }
 
-async function askClaudeForRelease(commits) {
+function extractPrNumber(subject, body) {
+  // "(#123)" suffix — squash-merge style
+  const m = subject.match(/\(#(\d+)\)\s*$/);
+  if (m) return parseInt(m[1], 10);
+  // "Merge pull request #123" — merge commit style
+  const mm = subject.match(/Merge pull request #(\d+)/);
+  if (mm) return parseInt(mm[1], 10);
+  // Same patterns in body
+  const bm = (body || '').match(/\(#(\d+)\)\s*$/m);
+  if (bm) return parseInt(bm[1], 10);
+  return null;
+}
+
+function fetchGitHubMeta(commits, lastTag) {
+  const repoRes = safeRun('gh repo view --json nameWithOwner -q .nameWithOwner');
+  if (!repoRes.ok) return commits;
+  const [owner, repo] = repoRes.out.trim().split('/');
+
+  // SHA → GitHub login via compare API (best-effort)
+  const shaToLogin = {};
+  if (lastTag) {
+    const cmpRes = safeRun(
+      `gh api "repos/${owner}/${repo}/compare/${lastTag}...HEAD" --jq '.commits[] | [.sha, (.author.login // "")] | @tsv'`,
+    );
+    if (cmpRes.ok) {
+      for (const line of cmpRes.out.trim().split('\n').filter(Boolean)) {
+        const [sha, login] = line.split('\t');
+        if (sha && login) shaToLogin[sha] = login;
+      }
+    }
+  }
+
+  // Merge commit SHA → PR number via pr list (best-effort)
+  const shaToPr = {};
+  const prRes = safeRun(
+    `gh pr list --state merged --limit 100 --json number,mergeCommit --jq '.[] | select(.mergeCommit != null) | [.mergeCommit.oid, (.number | tostring)] | @tsv'`,
+  );
+  if (prRes.ok) {
+    for (const line of prRes.out.trim().split('\n').filter(Boolean)) {
+      const [sha, num] = line.split('\t');
+      if (sha && num) shaToPr[sha] = parseInt(num, 10);
+    }
+  }
+
+  return commits.map(c => ({
+    ...c,
+    githubLogin: shaToLogin[c.hash] || null,
+    prNumber: shaToPr[c.hash] ?? extractPrNumber(c.subject, c.body),
+  }));
+}
+
+async function askClaudeForRelease(commits, isPublicPackage = false) {
   const apiKey = process.env.ANTHROPIC_API_KEY;
   if (!apiKey) return null;
 
-  const systemPrompt =
+  const basePrompt =
     'You are a release assistant. Given recent git commits, decide one of: major, minor, or patch following semver. Consider conventional commits, breaking changes, and scope. Also generate concise release notes for a public changelog. Respond with JSON containing "bump" (major/minor/patch), "reasoning" (brief explanation for version bump), and "notes" (array of 3-8 short bullet points of the most important user-facing changes). Use present tense for release notes (e.g. "Add script" not "Added script" or "Adds script"). Do not wrap the JSON in ```json or anything else.';
 
+  const publicExtra = isPublicPackage
+    ? ' Each commit may carry metadata in brackets like [by @login in #123]. When present, append that attribution verbatim at the end of the corresponding bullet point.'
+    : '';
+
+  const systemPrompt = basePrompt + publicExtra;
+
   const userContent = commits
     .map(c => {
       const body = c.body ? c.body.trim() : '';
       const truncatedBody = body.length > 500 ? body.slice(0, 500) + '…' : body;
-      return `- ${c.subject}\n${truncatedBody}`;
+      const meta = [];
+      if (c.githubLogin) meta.push(`by @${c.githubLogin}`);
+      if (c.prNumber) meta.push(`in #${c.prNumber}`);
+      const metaStr = meta.length ? ` [${meta.join(' ')}]` : '';
+      return `- ${c.subject}${metaStr}\n${truncatedBody}`;
     })
     .join('\n');
 
@@ -177,6 +238,12 @@ function prompt(question) {
   });
 }
 
+function hasReadmeChangelog() {
+  if (!fs.existsSync(readmePath)) return false;
+  const content = fs.readFileSync(readmePath, 'utf8');
+  return /^#\s*Changelog\s*$/im.test(content);
+}
+
 function parseArgs() {
   const args = process.argv.slice(2);
   const dryRun = args.includes('--dry-run');
@@ -203,10 +270,13 @@ function parseArgs() {
       console.log('🔍 DRY RUN MODE - No changes will be made\n');
     }
 
+    const pkg = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+    const isPublicPackage = !pkg.private;
+
     fetchOriginTags();
     const lastVersionTag = getLastVersionTag();
     const raw = getCommitRange(lastVersionTag);
-    const commits = parseCommits(raw);
+    let commits = parseCommits(raw);
     if (!commits.length) {
       console.log('No commits found since last tag. Aborting.');
       process.exit(1);
@@ -222,9 +292,13 @@ function parseArgs() {
       console.log(`  ${shortSha} ${commit.subject}`);
     });
 
+    if (isPublicPackage) {
+      commits = fetchGitHubMeta(commits, lastVersionTag);
+    }
+
     console.log('\nWaiting for Claude to analyze commits...');
 
-    const result = await askClaudeForRelease(commits);
+    const result = await askClaudeForRelease(commits, isPublicPackage);
 
     const { bump, reasoning, notes } = result;
 
@@ -242,7 +316,6 @@ function parseArgs() {
       process.exit(1);
     }
 
-    const pkg = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
     const curVersion = pkg.version;
     const newVersion = bumpVersionString(curVersion, finalBump);
 
@@ -284,32 +357,48 @@ function parseArgs() {
       process.exit(1);
     }
 
+    const useReadmeChangelog = hasReadmeChangelog();
+
     if (dryRun) {
       console.log(`\n🔍 DRY RUN - Would have done the following:`);
-      console.log(
-        `  1. Insert changelog entry for ${newVersion} into README.md`,
-      );
-      console.log(`  2. git add README.md`);
-      console.log(`  3. git commit -m "Update changelog for ${newVersion}"`);
-      console.log(`  4. npm version ${finalBump} -m "%s"`);
-      console.log(`  5. git push origin main --tags`);
+      let step = 1;
+      if (useReadmeChangelog) {
+        console.log(
+          `  ${step++}. Insert changelog entry for ${newVersion} into README.md`,
+        );
+        console.log(`  ${step++}. git add README.md`);
+        console.log(
+          `  ${step++}. git commit -m "Update changelog for ${newVersion}"`,
+        );
+      }
+      console.log(`  ${step++}. npm version ${finalBump} -m "%s"`);
+      console.log(`  ${step++}. git push origin main --tags`);
+      console.log(`  ${step++}. gh release create v${newVersion} --title "v${newVersion}" --notes-file <entry>`);
+      if (isPublicPackage) {
+        console.log(`  ${step++}. npm publish`);
+      }
       console.log(`\n✅ Dry run complete. Use without --dry-run to execute.`);
       fs.unlinkSync(tempEntryPath);
       return;
     }
 
-    // Read the edited entry and insert it into README
+    // Read the edited entry
     const editedEntry = fs.readFileSync(tempEntryPath, 'utf8');
-    const readme = fs.readFileSync(readmePath, 'utf8');
-    const updatedReadme = insertChangelogEntry(
-      readme,
-      editedEntry.trim().split('\n'),
-    );
-    fs.writeFileSync(readmePath, updatedReadme);
-    fs.unlinkSync(tempEntryPath);
 
-    run('git add README.md');
-    run(`git commit -m "Update changelog for ${newVersion}"`);
+    if (useReadmeChangelog) {
+      // Insert changelog entry into README.md
+      const readme = fs.readFileSync(readmePath, 'utf8');
+      const updatedReadme = insertChangelogEntry(
+        readme,
+        editedEntry.trim().split('\n'),
+      );
+      fs.writeFileSync(readmePath, updatedReadme);
+
+      run('git add README.md');
+      run(`git commit -m "Update changelog for ${newVersion}"`);
+    }
+
+    fs.unlinkSync(tempEntryPath);
 
     // Use npm version keyword per user preference
     run(`npm version ${finalBump} -m "%s"`);
@@ -317,6 +406,26 @@ function parseArgs() {
     // Push commit and tags explicitly
     run('git push origin main --tags');
 
+    // Create GitHub release
+    const ghNotesFile = path.join(
+      os.tmpdir(),
+      `release-notes-${crypto.randomBytes(8).toString('hex')}.md`,
+    );
+    fs.writeFileSync(ghNotesFile, editedEntry.trim());
+    try {
+      const releaseUrl = run(
+        `gh release create v${newVersion} --title "v${newVersion}" --notes-file "${ghNotesFile}"`,
+      ).trim();
+      console.log(`\n🎉 GitHub release created: ${releaseUrl}`);
+    } finally {
+      fs.unlinkSync(ghNotesFile);
+    }
+
+    if (isPublicPackage) {
+      run('npm publish');
+      console.log(`\n📦 Published ${pkg.name}@${newVersion} to npm.`);
+    }
+
     console.log(`\nRelease ${newVersion} created and pushed with tags.`);
   } catch (err) {
     console.error(err?.stderr?.toString?.() || err?.message || err);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-with-ease",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "description": "A script to bump the version of an npm library and update release notes. Uses Claude to analyze commits.",
   "main": "index.js",
   "bin": {