Skip to content

Conversation

@JanCizmar
Copy link
Contributor

@JanCizmar JanCizmar commented Dec 19, 2025

Summary by CodeRabbit

  • Chores
    • Enabled automatic changelog generation during releases for clearer release notes.
    • Improved release publishing configuration to better handle package publication.
    • Ensured the release workflow fetches full repository history so releases run with complete context.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Dec 19, 2025

Walkthrough

Updates to the repository's release automation: the GitHub Actions release workflow's checkout step now passes an explicit token and fetch-depth, and package.json's semantic-release plugins list was modified to include changelog and npm-related plugin entries.

Changes

Cohort / File(s) Change Summary
GitHub Actions Release Workflow
\.github/workflows/release.yml``
Added explicit checkout options to actions/checkout@v4: set with.secret to use GITHUB_TOKEN and fetch-depth: 0 to fetch full repository history.
Semantic-Release Configuration (package manifest)
\package.json``
Modified release.plugins array: added @semantic-release/changelog and adjusted @semantic-release/npm entries within the plugins list (reordered/relocated plugin entries).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

  • Inspect .github/workflows/release.yml checkout step for correct with key names and token reference.
  • Verify package.json release.plugins ordering and that plugin entries are valid objects/strings as expected.
  • Confirm CI secrets and semantic-release plugin compatibility in the repository environment.

Poem

🐰
With a hop and a tweak the workflow sings,
Tokens in paw and full-history wings.
Changelogs sprout where releases hop,
Npm notes tucked in the release crop.
A rabbit cheers — deploys won’t stop! 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'fix: Create changelog, push changes' directly reflects the main changes made to the PR: enabling changelog generation via @semantic-release/changelog plugin and configuring the release workflow to push changes properly.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch jancizmar/release-with-changelog

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 92591c6 and 0f08c7e.

📒 Files selected for processing (1)
  • package.json (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: E2E Tests (ubuntu-latest, 18)
  • GitHub Check: E2E Tests (ubuntu-latest, 20)
  • GitHub Check: E2E Tests (ubuntu-latest, 22)
🔇 Additional comments (1)
package.json (1)

117-118: LGTM! Plugin order follows semantic-release best practices.

The addition of @semantic-release/changelog and @semantic-release/npm plugins is correctly positioned. The changelog plugin must run first to update the CHANGELOG.md file, followed by the npm plugin to update package.json, so the git plugin can include both in the release commit.

The configuration uses sensible defaults that work for standard releases.


Comment @coderabbitai help to get the list of available commands and usage tips.

@JanCizmar JanCizmar merged commit ed47e7e into main Dec 19, 2025
32 of 33 checks passed
@JanCizmar JanCizmar deleted the jancizmar/release-with-changelog branch December 19, 2025 10:10
TolgeeMachine added a commit that referenced this pull request Dec 19, 2025
## [2.15.1](v2.15.0...v2.15.1) (2025-12-19)

### Bug Fixes

* Create changelog, push changes ([#196](#196)) ([ed47e7e](ed47e7e))
@github-actions
Copy link

🎉 This PR is included in version 2.15.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants