Add release notes to main repository for quick view

[rgsl888prabhu]

Description

Create a soft link to release notes in docs for quick view

Issue

closes #511

Checklist

• I am familiar with the Contributing Guidelines.
• Testing
  • New or existing tests cover these changes
  • Added tests
  • Created an issue to follow-up
  • NA
• Documentation
  • The documentation is up to date with these changes
  • Added new documentation
  • NA

Summary by CodeRabbit

• Documentation
  • Added a release notes page to the docs.
  • Added a "Latest Release Notes" link/section to the README.

[coderabbitai]

Walkthrough

Added a new cuOpt release notes documentation file at docs/cuopt/source/release-notes.rst and updated README.md to include a "Latest Release Notes" section linking to RELEASE_NOTES.md. No code or API changes were made.

Changes

Cohort / File(s)	Summary
Documentation - Release Notes docs/cuopt/source/release-notes.rst	New file added to documentation structure for release notes.
Repository README README.md	Added a "Latest Release Notes" section linking to RELEASE_NOTES.md (documentation navigation only).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A fresh note hops into view, concise and bright,
A link from the README, guiding users right.
No code to chew, just pages to share,
Release tales ready — handled with care. 🥕

Pre-merge checks and finishing touches

✅ Pre-merge checks override applied

The pre-merge checks have been overridden successfully. You can now proceed with the merge.

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The PR title "Add release notes to main repository for quick view" directly and concisely describes the main changes in this pull request. The title accurately reflects the addition of a "Latest Release Notes" section in README.md with a link to release notes documentation, which is exactly what the changeset implements. The phrasing is clear, specific, and avoids vague terminology, making it immediately understandable to someone reviewing the repository history.
Linked Issues Check	✅ Passed	The pull request successfully addresses the requirements from linked issue #511. The code changes add a "Latest Release Notes" section to README.md containing a link to release notes, which directly fulfills the objective to add a direct link to the latest release notes in the main repository. Additionally, the new docs/cuopt/source/release-notes.rst file is created as the target for this link, making release notes easily discoverable when new versions are released, as requested in the issue.
Out of Scope Changes Check	✅ Passed	All changes in this pull request are directly within scope and related to the objectives defined in linked issue #511. The modifications to README.md and the addition of the new release notes file are both necessary to implement the requested feature of adding a direct link to release notes in the main repository. No extraneous changes, unrelated refactoring, or out-of-scope functionality has been introduced.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f7bd5cc and 99aadaa.

📒 Files selected for processing (1)

• README.md (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• README.md

⏰ 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). (7)

• GitHub Check: conda-cpp-build / 13.0.1, 3.10, arm64, rockylinux8
• GitHub Check: wheel-build-cuopt-mps-parser / 13.0.1, 3.13, arm64, rockylinux8
• GitHub Check: wheel-build-cuopt-mps-parser / 13.0.1, 3.10, amd64, rockylinux8
• GitHub Check: wheel-build-cuopt-mps-parser / 13.0.1, 3.12, amd64, rockylinux8
• GitHub Check: wheel-build-cuopt-mps-parser / 13.0.1, 3.13, amd64, rockylinux8
• GitHub Check: wheel-build-cuopt-mps-parser / 13.0.1, 3.11, amd64, rockylinux8
• GitHub Check: wheel-build-cuopt-sh-client / 13.0.1, 3.10, amd64, rockylinux8

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[rgsl888prabhu]

@coderabbitai help

[coderabbitai]

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

CodeRabbit commands

These commands are invoked using PR/Issue comments.

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai evaluate custom pre-merge check --instructions <custom-checks-instructions> --name <custom-checks-title> [--mode <error|warning>] to validate the custom pre-merge checks instructions. Defaults to error when --mode is omitted.
  • @coderabbitai ignore pre-merge checks to override pre-merge checks and get an approval on PR.
  • @coderabbitai run pre-merge checks to run pre-merge checks on the pull request.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve to resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore or @coderabbit ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit configuration file (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, support, documentation and community

• Visit our status page to check the current availability of CodeRabbit.
• Create a ticket on our support page for assistance with any issues or questions.
• Visit our documentation site for detailed information on how to use CodeRabbit.
• Join our Discord community to connect with other users and get help from the community.
• Follow us on X/Twitter for updates and announcements.

[rgsl888prabhu]

/merge

[rgsl888prabhu]

/merge

[rgsl888prabhu]

/merge

[rgsl888prabhu]

/merge

[rgsl888prabhu]

@coderabbitai resolve

[coderabbitai]

✅ Actions performed

Comments resolved.

[rgsl888prabhu]

/merge

[rgsl888prabhu]

@coderabbitai ignore pre-merge checks

[coderabbitai]

✅ Actions performed

Pre-merge checks override command executed successfully.

[coderabbitai]

❌ Error

An error occurred while trying to override pre-merge checks. Please try again later.

[rgsl888prabhu]

@coderabbitai what is the merge status?

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Get the merge status and details of PR #512
gh pr view 512 --json mergeable,mergeStateStatus,statusCheckRollup,reviewDecision,commits,state,isDraft

# Also check the detailed status checks
gh pr checks 512

Length of output: 41383

---

@rgsl888prabhu, here's the current merge status for PR #512:

Status Summary:

• Merge State: 🔴 BLOCKED
• Review Decision: ✅ APPROVED
• Mergeable: ✅ No merge conflicts
• All CI/CD Checks: ✅ PASSED (including the final pr-builder check)

Details:
All 80+ CI/CD checks have passed successfully, including:

• Build checks (wheel, conda)
• Test suites (C++, Python)
• Documentation build
• Style and other checks
• Branch and label checkers

Why is it blocked?
Despite having approval and all checks passing, the PR is blocked from merging. This typically means there are branch protection rules in place that require:

• Additional approvals from specific reviewers or code owners
• Admin/maintainer merge permissions
• Other repository-specific requirements

Next Steps:

1. Check if you have merge permissions for the branch-25.12 target branch
2. Verify if additional approvals are needed from code owners
3. Contact a repository administrator if you believe the PR should be mergeable

Would you like me to help investigate the branch protection rules for this repository?

[rgsl888prabhu]

@CodeRabbit are you consuming "/merge" request ?

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

@rgsl888prabhu, no, CodeRabbit does not process /merge commands. The /merge command is not part of CodeRabbit's functionality.

What CodeRabbit Can Do:

• I can approve PRs when you ask me to (e.g., @coderabbitai approve)
• I can review code, resolve comments, pause/resume reviews, etc.
• However, I cannot merge pull requests

How to Merge:
To merge this PR, you'll need to use one of these methods:

1. GitHub UI: Click the merge button in the GitHub web interface
2. GitHub CLI: Use gh pr merge 512 (if you have permissions)
3. Git commands: Merge locally and push to the target branch
4. Other merge bots: If your repository uses a different bot (like Mergify, Kodiak, or a custom bot), that bot would handle /merge commands

Based on my earlier status check, your PR is approved and all checks have passed, but it's currently blocked due to branch protection rules. You'll need the appropriate merge permissions or additional approvals to proceed with the merge.

Is there anything else I can help you with regarding this PR? 🐰

[rgsl888prabhu]

@coderabbitai approve

[coderabbitai]

✅ Actions performed

Comments resolved.