Open
Conversation
In order to make it easier to track what version of fact has what features, a rough best-effort maintained change log file has been added. This new file will require some additional work during releases, so the corresponding release document has been updated. Some release instructions for Konflux have been removed, these are now the responsibility of the release engineer and we do not have to do them ourselves. The PR template also gets a new item in the checklist, reminding people to add an entry in the change log if one is required.
📝 WalkthroughWalkthroughThis PR establishes changelog documentation practices and restructures the release workflow. The PR template now requires changelog entries, a new CHANGELOG.md file documents project history, and the release process documentation adds explicit version and changelog update steps on both main and release branches before Konflux tagging. ChangesChangelog and Release Process Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/release.md (1)
59-60: ⚡ Quick winAvoid
git add .in release docs; stage only intended files.Using
git add .can accidentally include unrelated local changes during release prep. It’s safer to stage explicit files in these scripted steps.Suggested fix
- git add . + git add CHANGELOG.md fact/Cargo.toml- git add . + git add constants.mk fact/Cargo.tomlAs per coding guidelines, "Focus on major issues impacting performance, readability, maintainability and security. Avoid nitpicks and avoid verbosity."
Also applies to: 97-99
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/release.md` around lines 59 - 60, Replace the unsafe "git add ." step in the release script with explicit staging of only the intended files (e.g., the changelog, versioned files, and any build outputs referenced by the commit message `"chore: update change log and application version for ${FACT_RELEASE}"`) so unrelated local changes are not included; update the release documentation lines containing `git add .` to list the specific files to stage instead (for example, the changelog file and files that hold the application version) and keep the commit command unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/release.md`:
- Around line 86-87: The current sed invocation only replaces the literal token
"stable" and will silently do nothing if constants.mk already contains a pinned
value; update the replacement to target the whole RUST_VERSION line so it always
sets RUST_VERSION to the desired value. Change the sed expression used on
constants.mk to match a line starting with "RUST_VERSION" and replace the entire
line with "RUST_VERSION ${RUST_VERSION}" (i.e., operate on the whole line rather
than the word "stable") so the file is reliably updated.
---
Nitpick comments:
In `@docs/release.md`:
- Around line 59-60: Replace the unsafe "git add ." step in the release script
with explicit staging of only the intended files (e.g., the changelog, versioned
files, and any build outputs referenced by the commit message `"chore: update
change log and application version for ${FACT_RELEASE}"`) so unrelated local
changes are not included; update the release documentation lines containing `git
add .` to list the specific files to stage instead (for example, the changelog
file and files that hold the application version) and keep the commit command
unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Central YAML (base), Organization UI (inherited)
Review profile: CHILL
Plan: Enterprise
Run ID: d464933a-af22-4068-bfbe-0dddcb04972c
📒 Files selected for processing (3)
.github/pull_request_template.mdCHANGELOG.mddocs/release.md
|
CodeRabbit chat interactions are restricted to organization members for this repository. Ask an organization member to interact with CodeRabbit, or set |
Contributor
Author
|
@coderabbitai help |
ChatThere are 3 ways to chat with CodeRabbit:
CodeRabbit commands
Other keywords and placeholders
Status, support, documentation and community
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
In order to make it easier to track what version of fact has what features, a rough best-effort maintained change log file has been added. This new file will require some additional work during releases, so the corresponding release document has been updated.
Some release instructions for Konflux have been removed, these are now the responsibility of the release engineer and we do not have to do them ourselves.
The PR template also gets a new item in the checklist, reminding people to add an entry in the change log if one is required.
Checklist
Automated testing
If any of these don't apply, please comment below.
Testing Performed
The commands in the release document have been tested manually. Once a new release takes place, any future adjustments will be made in a follow up PR.