|
| 1 | +#!/usr/bin/env node |
| 2 | + |
| 3 | +/** |
| 4 | + * Format Rust GitHub release notes with shields.io badges. |
| 5 | + * |
| 6 | + * Adds to the release body: |
| 7 | + * - crates.io version badge |
| 8 | + * - docs.rs badge |
| 9 | + * |
| 10 | + * Usage: |
| 11 | + * node scripts/format-rust-release.mjs \ |
| 12 | + * --release-version <version> \ |
| 13 | + * --repository <owner/repo> \ |
| 14 | + * [--crate-name <name>] |
| 15 | + * |
| 16 | + * Environment variables: |
| 17 | + * VERSION – fallback for --release-version |
| 18 | + * REPOSITORY – fallback for --repository |
| 19 | + * CRATE_NAME – fallback for --crate-name |
| 20 | + */ |
| 21 | + |
| 22 | +import { execSync } from 'child_process'; |
| 23 | + |
| 24 | +// --------------------------------------------------------------------------- |
| 25 | +// Argument parsing (named flags) |
| 26 | +// --------------------------------------------------------------------------- |
| 27 | +const args = process.argv.slice(2); |
| 28 | +const getArg = (name, defaultValue = '') => { |
| 29 | + const idx = args.indexOf(`--${name}`); |
| 30 | + return idx >= 0 && args[idx + 1] ? args[idx + 1] : defaultValue; |
| 31 | +}; |
| 32 | + |
| 33 | +const version = getArg('release-version', process.env.VERSION || ''); |
| 34 | +const repository = getArg('repository', process.env.REPOSITORY || ''); |
| 35 | +// Default crate name derived from repo name (last segment) |
| 36 | +const defaultCrateName = repository.split('/').pop() || ''; |
| 37 | +const crateName = getArg('crate-name', process.env.CRATE_NAME || defaultCrateName); |
| 38 | + |
| 39 | +if (!version || !repository) { |
| 40 | + console.error('Error: Missing required arguments'); |
| 41 | + console.error( |
| 42 | + 'Usage: node scripts/format-rust-release.mjs --release-version <version> --repository <owner/repo>' |
| 43 | + ); |
| 44 | + process.exit(1); |
| 45 | +} |
| 46 | + |
| 47 | +const versionWithoutV = version.replace(/^v/, ''); |
| 48 | +const tag = `v${versionWithoutV}`; |
| 49 | + |
| 50 | +// --------------------------------------------------------------------------- |
| 51 | +// Shields.io badges for Rust |
| 52 | +// --------------------------------------------------------------------------- |
| 53 | +const cratesIoBadge = `[](https://crates.io/crates/${crateName})`; |
| 54 | +const docsRsBadge = `[](https://docs.rs/${crateName})`; |
| 55 | +const badgeLine = `${cratesIoBadge} ${docsRsBadge}`; |
| 56 | +const packageLinks = |
| 57 | + `📦 **View on crates.io:** https://crates.io/crates/${crateName}/${versionWithoutV}\n` + |
| 58 | + `📖 **API docs:** https://docs.rs/${crateName}/${versionWithoutV}`; |
| 59 | + |
| 60 | +// --------------------------------------------------------------------------- |
| 61 | +// Fetch and update the release |
| 62 | +// --------------------------------------------------------------------------- |
| 63 | +try { |
| 64 | + // Look up the release by tag |
| 65 | + let releaseData; |
| 66 | + try { |
| 67 | + releaseData = JSON.parse( |
| 68 | + execSync(`gh api repos/${repository}/releases/tags/${tag}`, { |
| 69 | + encoding: 'utf8', |
| 70 | + }) |
| 71 | + ); |
| 72 | + } catch { |
| 73 | + console.log(`⚠️ Could not find release for ${tag}`); |
| 74 | + process.exit(0); |
| 75 | + } |
| 76 | + |
| 77 | + const { id: releaseId, body: currentBody = '' } = releaseData; |
| 78 | + |
| 79 | + // Skip if already formatted |
| 80 | + if (currentBody.includes('img.shields.io')) { |
| 81 | + console.log('ℹ️ Release notes already contain badges – skipping'); |
| 82 | + process.exit(0); |
| 83 | + } |
| 84 | + |
| 85 | + const formattedBody = |
| 86 | + `${currentBody.trimEnd()}\n\n---\n\n${badgeLine}\n\n${packageLinks}`; |
| 87 | + |
| 88 | + const updatePayload = JSON.stringify({ body: formattedBody }); |
| 89 | + execSync( |
| 90 | + `gh api repos/${repository}/releases/${releaseId} -X PATCH --input -`, |
| 91 | + { encoding: 'utf8', input: updatePayload } |
| 92 | + ); |
| 93 | + |
| 94 | + console.log(`✅ Formatted Rust release notes for ${tag}`); |
| 95 | + console.log(' - Added crates.io version badge'); |
| 96 | + console.log(' - Added docs.rs badge'); |
| 97 | +} catch (error) { |
| 98 | + console.error('❌ Error formatting Rust release notes:', error.message); |
| 99 | + process.exit(1); |
| 100 | +} |
0 commit comments