|
| 1 | +name: Generate Release Notes |
| 2 | +on: |
| 3 | + workflow_call: |
| 4 | + inputs: |
| 5 | + tag: |
| 6 | + required: true |
| 7 | + type: string |
| 8 | + description: "The CalVer release tag to generate notes for" |
| 9 | + outputs: |
| 10 | + notes: |
| 11 | + description: "Generated release notes body (Markdown)" |
| 12 | + value: ${{ jobs.generate-notes.outputs.notes }} |
| 13 | + |
| 14 | +jobs: |
| 15 | + generate-notes: |
| 16 | + name: Generate Release Notes |
| 17 | + runs-on: ubuntu-latest |
| 18 | + permissions: |
| 19 | + contents: read |
| 20 | + pull-requests: read |
| 21 | + outputs: |
| 22 | + notes: ${{ steps.read_notes.outputs.notes }} |
| 23 | + |
| 24 | + steps: |
| 25 | + - name: Checkout repository |
| 26 | + uses: actions/checkout@v6 |
| 27 | + with: |
| 28 | + fetch-depth: 0 |
| 29 | + |
| 30 | + - name: Gather release data |
| 31 | + id: gather |
| 32 | + uses: actions/github-script@v9 |
| 33 | + with: |
| 34 | + script: | |
| 35 | + const currentTag = '${{ inputs.tag }}'; |
| 36 | + const calVerRegex = /^\d{4}\.\d{2}\.\d{2}\.\d+$/; |
| 37 | + const fs = require('fs'); |
| 38 | +
|
| 39 | + // Returns the timestamp that best represents when this tag was pushed. |
| 40 | + // For annotated tags: the tagger.date embedded in the tag object. |
| 41 | + // For lightweight tags (used by this project): the committer.date of the |
| 42 | + // commit the tag points to, which is the closest proxy available via the |
| 43 | + // GitHub API for when the tag was pushed. |
| 44 | + async function getTagDate(tag) { |
| 45 | + const ref = await github.rest.git.getRef({ |
| 46 | + owner: context.repo.owner, |
| 47 | + repo: context.repo.repo, |
| 48 | + ref: `tags/${tag}`, |
| 49 | + }); |
| 50 | +
|
| 51 | + if (ref.data.object.type === 'tag') { |
| 52 | + const tagObj = await github.rest.git.getTag({ |
| 53 | + owner: context.repo.owner, |
| 54 | + repo: context.repo.repo, |
| 55 | + tag_sha: ref.data.object.sha, |
| 56 | + }); |
| 57 | + return new Date(tagObj.data.tagger.date); |
| 58 | + } |
| 59 | +
|
| 60 | + const commit = await github.rest.git.getCommit({ |
| 61 | + owner: context.repo.owner, |
| 62 | + repo: context.repo.repo, |
| 63 | + commit_sha: ref.data.object.sha, |
| 64 | + }); |
| 65 | + return new Date(commit.data.committer.date); |
| 66 | + } |
| 67 | +
|
| 68 | + const currentDate = await getTagDate(currentTag); |
| 69 | + core.info(`Current tag ${currentTag} date: ${currentDate.toISOString()}`); |
| 70 | +
|
| 71 | + // Use listReleases (not listTags) so we only compare against actual published |
| 72 | + // releases, not stray tags or pre-releases that were never shipped. |
| 73 | + const releases = await github.paginate(github.rest.repos.listReleases, { |
| 74 | + owner: context.repo.owner, |
| 75 | + repo: context.repo.repo, |
| 76 | + per_page: 100, |
| 77 | + }); |
| 78 | +
|
| 79 | + // Find the most-recent CalVer release that comes before the current one. |
| 80 | + // Sort descending by CalVer parts so [0] is the newest prior release. |
| 81 | + const prevRelease = releases |
| 82 | + .filter(r => !r.prerelease && calVerRegex.test(r.tag_name) && r.tag_name !== currentTag) |
| 83 | + .sort((a, b) => { |
| 84 | + const pa = a.tag_name.split('.').map(Number); |
| 85 | + const pb = b.tag_name.split('.').map(Number); |
| 86 | + for (let i = 0; i < 4; i++) { |
| 87 | + if (pa[i] !== pb[i]) return pb[i] - pa[i]; |
| 88 | + } |
| 89 | + return 0; |
| 90 | + })[0]; |
| 91 | +
|
| 92 | + let prevDate = null; |
| 93 | + let prevTag = null; |
| 94 | +
|
| 95 | + if (prevRelease) { |
| 96 | + prevTag = prevRelease.tag_name; |
| 97 | + prevDate = await getTagDate(prevTag); |
| 98 | + core.info(`Previous release ${prevTag} date: ${prevDate.toISOString()}`); |
| 99 | + } else { |
| 100 | + core.info('No previous CalVer release found — this appears to be the first release'); |
| 101 | + } |
| 102 | +
|
| 103 | + // Collect PRs whose merged_at falls strictly after prevDate and on/before currentDate. |
| 104 | + const allPRs = await github.paginate(github.rest.pulls.list, { |
| 105 | + owner: context.repo.owner, |
| 106 | + repo: context.repo.repo, |
| 107 | + state: 'closed', |
| 108 | + per_page: 100, |
| 109 | + }); |
| 110 | +
|
| 111 | + const relevantPRs = allPRs |
| 112 | + .filter(pr => { |
| 113 | + if (!pr.merged_at) return false; |
| 114 | + const mergedAt = new Date(pr.merged_at); |
| 115 | + if (prevDate && mergedAt <= prevDate) return false; |
| 116 | + return mergedAt <= currentDate; |
| 117 | + }) |
| 118 | + .map(pr => ({ |
| 119 | + number: pr.number, |
| 120 | + title: pr.title, |
| 121 | + author: pr.user?.login ?? 'unknown', |
| 122 | + labels: pr.labels.map(l => l.name), |
| 123 | + merged_at: pr.merged_at, |
| 124 | + body: (pr.body ?? '').substring(0, 1000), |
| 125 | + })); |
| 126 | +
|
| 127 | + core.info(`Found ${relevantPRs.length} PRs in this release window`); |
| 128 | +
|
| 129 | + // Collect commits pushed to main between the two tag dates. |
| 130 | + const allCommits = await github.paginate(github.rest.repos.listCommits, { |
| 131 | + owner: context.repo.owner, |
| 132 | + repo: context.repo.repo, |
| 133 | + sha: 'main', |
| 134 | + since: prevDate ? prevDate.toISOString() : undefined, |
| 135 | + until: currentDate.toISOString(), |
| 136 | + per_page: 100, |
| 137 | + }); |
| 138 | +
|
| 139 | + const relevantCommits = allCommits.map(c => ({ |
| 140 | + sha: c.sha.substring(0, 7), |
| 141 | + message: c.commit.message.split('\n')[0], |
| 142 | + author: c.commit.author?.name ?? c.author?.login ?? 'unknown', |
| 143 | + date: c.commit.committer?.date ?? null, |
| 144 | + })); |
| 145 | +
|
| 146 | + core.info(`Found ${relevantCommits.length} commits in this release window`); |
| 147 | +
|
| 148 | + const releaseData = { |
| 149 | + currentTag, |
| 150 | + previousTag: prevTag, |
| 151 | + currentDate: currentDate.toISOString(), |
| 152 | + previousDate: prevDate ? prevDate.toISOString() : null, |
| 153 | + pullRequests: relevantPRs, |
| 154 | + commits: relevantCommits, |
| 155 | + }; |
| 156 | +
|
| 157 | + fs.writeFileSync('release-data.json', JSON.stringify(releaseData, null, 2)); |
| 158 | + core.info('Wrote release-data.json'); |
| 159 | +
|
| 160 | + - name: Run release notes agent |
| 161 | + id: release_notes_agent |
| 162 | + uses: mcowger/pi-coding-agent-action@main |
| 163 | + with: |
| 164 | + github_token: ${{ secrets.GITHUB_TOKEN }} |
| 165 | + provider: openrouter |
| 166 | + model: ${{ vars.LLM_MODEL_ID }} |
| 167 | + token: ${{ secrets.LLM_API_KEY }} |
| 168 | + base_url: ${{ secrets.LLM_API_HOST }} |
| 169 | + trigger: generate-release-notes |
| 170 | + load_builtin_extensions: true |
| 171 | + suppress_final_comment: true |
| 172 | + export_session_html: true |
| 173 | + prompt_file: .github/prompts/release-notes.md |
| 174 | + env: |
| 175 | + RELEASE_TAG: ${{ inputs.tag }} |
| 176 | + |
| 177 | + - name: Read agent-generated notes |
| 178 | + id: read_notes |
| 179 | + if: always() |
| 180 | + run: | |
| 181 | + if [ -f release-notes.md ]; then |
| 182 | + { |
| 183 | + echo 'notes<<RELEASE_NOTES_EOF' |
| 184 | + cat release-notes.md |
| 185 | + echo 'RELEASE_NOTES_EOF' |
| 186 | + } >> "$GITHUB_OUTPUT" |
| 187 | + else |
| 188 | + echo '::warning::Agent did not write release-notes.md — release will have no body' |
| 189 | + echo 'notes=' >> "$GITHUB_OUTPUT" |
| 190 | + fi |
| 191 | +
|
| 192 | + - name: Upload agent session |
| 193 | + if: always() |
| 194 | + uses: actions/upload-artifact@v7 |
| 195 | + with: |
| 196 | + name: release-notes-session |
| 197 | + path: ${{ steps.release_notes_agent.outputs.session_html_path }} |
| 198 | + retention-days: 7 |
| 199 | + if-no-files-found: ignore |
| 200 | + archive: false |
0 commit comments