ci: add job to update changelog

Author: danielroe

.github/workflows/changelog.yml

@@ -0,0 +1,37 @@
+name: release
+
+on:
+push:
+branches:
+ - main
+
+permissions:
+pull-requests: write
+contents: write
+
+concurrency:
+group: ${{ github.workflow }}-${{ github.event.number || github.sha }}
+cancel-in-progress: ${{ github.event_name != 'push' }}
+
+jobs:
+update-changelog:
+if: github.repository_owner == 'nuxt'
+runs-on: ubuntu-latest
+
+steps:
+ - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+with:
+fetch-depth: 0
+ - run: corepack enable
+ - uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
+with:
+node-version: lts/*
+cache: pnpm
+
+ - name: 📦 Install dependencies
+run: pnpm install
+
+ - name: 🚧 Update changelog
+run: node --experimental-strip-types ./scripts/update-changelog.ts
+env:
+GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package.json

@@ -25,11 +25,13 @@
 "@antfu/eslint-config": "^4.1.0",
 "@nuxt/eslint-config": "^0.7.5",
 "@types/node": "^22.12.0",
+"@types/semver": "^7.5.8",
 "@vitest/coverage-v8": "^3.0.4",
 "changelogen": "^0.5.7",
 "eslint": "^9.19.0",
 "knip": "^5.43.6",
 "pkg-pr-new": "^0.0.39",
+"semver": "^7.6.3",
 "std-env": "^3.8.0",
 "tinyexec": "^0.3.2",
 "typescript": "^5.7.3",

pnpm-lock.yaml

@@ -0,0 +1,237 @@
+importtype{ResolvedChangelogConfig}from'changelogen'
+
+import{execSync}from'node:child_process'
+import{promisesasfsp}from'node:fs'
+import{join,resolve}from'node:path'
+importprocessfrom'node:process'
+
+import{determineSemverChange,generateMarkDown,getCurrentGitBranch,getGitDiff,loadChangelogConfig,parseCommits}from'changelogen'
+import{inc}from'semver'
+
+constrepo=`nuxt/cli`
+constcorePackage='nuxi'
+constignoredPackages=['create-nuxt-app']
+constuser={
+name: 'Daniel Roe',
+email: 'daniel@roe.dev',
+}
+
+asyncfunctionmain(){
+constreleaseBranch=getCurrentGitBranch()
+constworkspace=awaitloadWorkspace(process.cwd())
+constconfig=awaitloadChangelogConfig(process.cwd(),{})
+
+constcommits=awaitgetLatestCommits(config).then(commits=>commits.filter(c=>config.types[c.type]&&!(c.type==='chore'&&c.scope==='deps'&&!c.isBreaking)))
+constbumpType=(awaitdetermineBumpType(config))||'patch'
+
+constnewVersion=inc(workspace.find(corePackage).data.version,bumpType)
+constchangelog=awaitgenerateMarkDown(commits,config)
+
+// Create and push a branch with bumped versions if it has not already been created
+constbranchExists=execSync(`git ls-remote --heads origin v${newVersion}`).toString().trim().length>0
+if(!branchExists){
+for(const[key,value]ofObject.entries(user)){
+execSync(`git config --global user.${key} "${value}"`)
+execSync(`git config --global user.${key} "${value}"`)
+}
+execSync(`git checkout -b v${newVersion}`)
+
+for(constpkgofworkspace.packages.filter(p=>!p.data.private)){
+workspace.setVersion(pkg.data.name,newVersion!)
+}
+awaitworkspace.save()
+
+execSync(`git commit -am v${newVersion}`)
+execSync(`git push -u origin v${newVersion}`)
+}
+
+// Get the current PR for this release, if it exists
+const[currentPR]=awaitfetch(`https://api.github.com/repos/${repo}/pulls?head=nuxt:v${newVersion}`).then(r=>r.json())
+constcontributors=awaitgetContributors()
+
+constreleaseNotes=[
+currentPR?.body.replace(/##👉Changelog[\s\S]*$/,'')||`> ${newVersion} is the next ${bumpType} release.\n>\n> **Timetable**: to be announced.`,
+'## 👉 Changelog',
+changelog
+.replace(/^##v.*\n/,'')
+.replace(`...${releaseBranch}`,`...v${newVersion}`)
+.replace(/###❤️Contributors[\s\S]*$/,''),
+'### ❤️ Contributors',
+contributors.map(c=>`- ${c.name} (@${c.username})`).join('\n'),
+].join('\n')
+
+// Create a PR with release notes if none exists
+if(!currentPR){
+returnawaitfetch(`https://api.github.com/repos/${repo}/pulls`,{
+method: 'POST',
+headers: {
+'Authorization': `token ${process.env.GITHUB_TOKEN}`,
+'content-type': 'application/json',
+},
+body: JSON.stringify({
+title: `v${newVersion}`,
+head: `v${newVersion}`,
+base: releaseBranch,
+body: releaseNotes,
+draft: true,
+}),
+})
+}
+
+// Update release notes if the pull request does exist
+awaitfetch(`https://api.github.com/repos/${repo}/pulls/${currentPR.number}`,{
+method: 'PATCH',
+headers: {
+'Authorization': `token ${process.env.GITHUB_TOKEN}`,
+'content-type': 'application/json',
+},
+body: JSON.stringify({
+body: releaseNotes,
+}),
+})
+}
+
+main().catch((err)=>{
+console.error(err)
+process.exit(1)
+})
+
+exportinterfaceDep{
+name: string
+range: string
+type: string
+}
+
+typeThenArg<T>=TextendsPromiseLike<infer U> ? U : T
+exporttypePackage=ThenArg<ReturnType<typeofloadPackage>>
+
+exportasyncfunctionloadPackage(dir: string){
+constpkgPath=resolve(dir,'package.json')
+constdata=JSON.parse(awaitfsp.readFile(pkgPath,'utf-8').catch(()=>'{}'))
+constsave=()=>fsp.writeFile(pkgPath,`${JSON.stringify(data,null,2)}\n`)
+
+constupdateDeps=(reviver: (dep: Dep)=>Dep|void)=>{
+for(consttypeof['dependencies','devDependencies','optionalDependencies','peerDependencies']){
+if(!data[type]){
+continue
+}
+for(consteofObject.entries(data[type])){
+constdep: Dep={name: e[0],range: e[1]asstring, type }
+deletedata[type][dep.name]
+constupdated=reviver(dep)||dep
+data[updated.type]=data[updated.type]||{}
+data[updated.type][updated.name]=updated.range
+}
+}
+}
+
+return{
+ dir,
+ data,
+ save,
+ updateDeps,
+}
+}
+
+exportasyncfunctionloadWorkspace(dir: string){
+constworkspacePkg=awaitloadPackage(dir)
+
+constpackages: Package[]=[]
+
+forawait(constpkgDiroffsp.glob(['packages/*'],{withFileTypes: true})){
+if(!pkgDir.isDirectory()){
+continue
+}
+constpkg=awaitloadPackage(join(pkgDir.parentPath,pkgDir.name))
+if(!pkg.data.name||ignoredPackages.includes(pkg.data.name)){
+continue
+}
+console.log(pkg.data.name)
+packages.push(pkg)
+}
+
+constfind=(name: string)=>{
+constpkg=packages.find(pkg=>pkg.data.name===name)
+if(!pkg){
+thrownewError(`Workspace package not found: ${name}`)
+}
+returnpkg
+}
+
+constrename=(from: string,to: string)=>{
+find(from).data._name=find(from).data.name
+find(from).data.name=to
+for(constpkgofpackages){
+pkg.updateDeps((dep)=>{
+if(dep.name===from&&!dep.range.startsWith('npm:')){
+dep.range=`npm:${to}@${dep.range}`
+}
+})
+}
+}
+
+constsetVersion=(name: string,newVersion: string,opts: {updateDeps?: boolean}={})=>{
+find(name).data.version=newVersion
+if(!opts.updateDeps){
+return
+}
+
+for(constpkgofpackages){
+pkg.updateDeps((dep)=>{
+if(dep.name===name){
+dep.range=newVersion
+}
+})
+}
+}
+
+constsave=()=>Promise.all(packages.map(pkg=>pkg.save()))
+
+return{
+ dir,
+ workspacePkg,
+ packages,
+ save,
+ find,
+ rename,
+ setVersion,
+}
+}
+
+exportasyncfunctiondetermineBumpType(config: ResolvedChangelogConfig){
+constcommits=awaitgetLatestCommits(config)
+
+constbumpType=determineSemverChange(commits,config)
+
+returnbumpType==='major' ? 'minor' : bumpType
+}
+
+exportasyncfunctiongetLatestCommits(config: ResolvedChangelogConfig){
+constlatestTag=execSync('git describe --tags --abbrev=0').toString().trim()
+
+returnparseCommits(awaitgetGitDiff(latestTag),config)
+}
+
+exportasyncfunctiongetContributors(){
+constcontributors=[]asArray<{name: string,username: string}>
+constemails=newSet<string>()
+constlatestTag=execSync('git describe --tags --abbrev=0').toString().trim()
+constrawCommits=awaitgetGitDiff(latestTag)
+for(constcommitofrawCommits){
+if(emails.has(commit.author.email)||commit.author.name==='renovate[bot]'){
+continue
+}
+const{ author }=awaitfetch(`https://api.github.com/repos/${repo}/commits/${commit.shortHash}`,{
+headers: {
+'User-Agent': `${repo} github action automation`,
+'Accept': 'application/vnd.github.v3+json',
+'Authorization': `token ${process.env.GITHUB_TOKEN}`,
+},
+}).then(r=>r.json()asPromise<{author: {login: string,email: string}}>)
+if(!contributors.some(c=>c.username===author.login)){
+contributors.push({name: commit.author.name,username: author.login})
+}
+emails.add(author.email)
+}
+returncontributors
+}