[PR #434] [MERGED] fix(ci): normalize generated release metadata #1983

New issue

Closed

opened 2026-10-16 21:13:04 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-16 21:13:04 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/434
Author: @morluto
Created: 7/24/2026
Status: ✅ Merged
Merged: 7/24/2026
Merged by: @morluto

Base: main ← Head: codex/normalize-release-pr-metadata

📝 Commits (1)

119954c fix(ci): normalize release pull request metadata

📊 Changes

1 file changed (+56 additions, -4 deletions)

View changed files

📝 .github/workflows/release.yml (+56 -4)

📄 Description

Description

Release Please updates docs/product-catalog.json with its JSON serializer, while the repository generator emits Prettier-canonical JSON. Release PRs consequently fail documentation, formatting, and catalog tests until the file is regenerated manually.

After Release Please creates or updates a PR, the release workflow now checks out that exact head branch, runs npm run docs:generate, and commits the canonical catalog when needed. The write is limited to docs/product-catalog.json; unexpected generated changes fail the workflow. Release runs are serialized to prevent competing updates, checkout credentials are not persisted during generation, and job permissions are scoped separately for release PR maintenance and npm publication.

Type of Change

Bug fix

Testing Performed

npm run docs:generate
npm run check:ci
npx prettier --check .github/workflows/release.yml
go run github.com/rhysd/actionlint/cmd/actionlint@v1.7.7 .github/workflows/release.yml

The branch-write path itself runs only when Release Please creates or updates a release PR, so it was not exercised locally.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/morluto/rea/pull/434 **Author:** [@morluto](https://github.com/morluto) **Created:** 7/24/2026 **Status:** ✅ Merged **Merged:** 7/24/2026 **Merged by:** [@morluto](https://github.com/morluto) **Base:** `main` ← **Head:** `codex/normalize-release-pr-metadata` --- ### 📝 Commits (1) - [`119954c`](https://github.com/morluto/rea/commit/119954c701533491ccbc4de649592e059f3f5d39) fix(ci): normalize release pull request metadata ### 📊 Changes **1 file changed** (+56 additions, -4 deletions) <details> <summary>View changed files</summary> 📝 `.github/workflows/release.yml` (+56 -4) </details> ### 📄 Description ## Description Release Please updates `docs/product-catalog.json` with its JSON serializer, while the repository generator emits Prettier-canonical JSON. Release PRs consequently fail documentation, formatting, and catalog tests until the file is regenerated manually. After Release Please creates or updates a PR, the release workflow now checks out that exact head branch, runs `npm run docs:generate`, and commits the canonical catalog when needed. The write is limited to `docs/product-catalog.json`; unexpected generated changes fail the workflow. Release runs are serialized to prevent competing updates, checkout credentials are not persisted during generation, and job permissions are scoped separately for release PR maintenance and npm publication. ## Type of Change - [x] Bug fix ## Testing Performed - [x] `npm run docs:generate` - [x] `npm run check:ci` - [x] `npx prettier --check .github/workflows/release.yml` - [x] `go run github.com/rhysd/actionlint/cmd/actionlint@v1.7.7 .github/workflows/release.yml` The branch-write path itself runs only when Release Please creates or updates a release PR, so it was not exercised locally. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-16 21:13:04 +00:00