ci: build changelog helper before running it - #6117
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (2)
Included review availability: Your plan provides up to 10 included reviews per hour; 8 remain after this review. WalkthroughThe changelog workflow now builds and runs a helper binary. The documentation workflow now tracks changelog workflow and release-task changes for pull requests and pushes. ChangesChangelog workflows
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~5 minutes Change: Bug fix Suggested reviewers: Merge Risk: ⚪ Minimal · up to The workflow changes use the correct module and repository-root execution contexts, and the documentation triggers cover the intended paths. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. A rabbit builds a helper bright Comment |
There was a problem hiding this comment.
🟢 Approval recommended
The workflow adjustments are internally consistent and directly address the reported module/context execution failure without introducing risky logic changes.
Pull request overview
This PR fixes the v3 auto-changelog CI job by compiling the auto-changelog.go helper inside the v3 Go module (where its dependencies resolve correctly with GOWORK=off), then running the resulting binary from the repository root so repository-relative changelog/docs paths remain correct. It also updates the docs workflow path filters so changes to the auto-changelog workflow trigger the documentation automation checks as intended.
Changes:
- Build the auto-changelog helper binary in
v3/(alongside its tests) and run the compiled binary from repo root. - Expand
docs-mpress.ymlpath filters to include changes to.github/workflows/auto-changelog-v3.yml.
File summaries
| File | Description |
|---|---|
| .github/workflows/docs-mpress.yml | Adds the auto-changelog workflow file to path filters so docs automation runs when that workflow changes. |
| .github/workflows/auto-changelog-v3.yml | Tests + builds auto-changelog.go in v3/, then executes the compiled helper from repo root to avoid module-resolution issues. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
The post-merge changelog job failed after #6116 because
go run v3/scripts/auto-changelog.goexecutes outside the v3 module with GOWORK disabled. The helper now imports the existing TOML parser to read MPD metadata.Build the helper in the v3 module alongside its tests, then execute the compiled binary from the repository root so its repository-relative changelog and documentation paths remain correct. Changes to this workflow also trigger the documentation automation checks.
Validation: helper tests pass, the binary builds in the v3 module, and invoking it from the repository root reaches its expected environment validation. Both workflow files parse successfully.
Summary by CodeRabbit