Skip to content

docs: Add release information - #1072

Open
cassidyjames wants to merge 4 commits into
mainfrom
cassidyjames/docs-releases
Open

docs: Add release information#1072
cassidyjames wants to merge 4 commits into
mainfrom
cassidyjames/docs-releases

Conversation

@cassidyjames

@cassidyjames cassidyjames commented Aug 26, 2026

Copy link
Copy Markdown
Member

Addresses roostorg/community#74, and reflects the changes in roostorg/osprey#475.

Summary by CodeRabbit

  • Documentation
    • Added a Development Guide section explaining the release process.
    • Documented release timing and Semantic Versioning conventions.
    • Added instructions for creating releases.
    • Described automated Docker image builds and documentation snapshots triggered when a release is published.

@coderabbitai

coderabbitai Bot commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 649fe672-5b44-43e7-8d8b-e18dbd343b06

📥 Commits

Reviewing files that changed from the base of the PR and between c40dc6d and a60aebc.

📒 Files selected for processing (2)
  • docs/SUMMARY.md
  • docs/development/releases.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

Adds a release process guide covering release triggers, Semantic Versioning, release steps, and publish automations. Adds the guide to the documentation table of contents.

Changes

Release documentation

Layer / File(s) Summary
Release guide and navigation
docs/development/releases.md, docs/SUMMARY.md
Adds the release process guide and links it from the Development Guide section. The guide describes release triggers, Semantic Versioning rules, release steps, and Docker image and documentation automations.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to a60ae

This documentation-only change adds release guidance and a navigation link without affecting runtime behavior; no actionable merge-blocking risk remains after normal checks and review.

Suggested reviewers: annebdh

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: adding release information to the documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch cassidyjames/docs-releases

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

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

@cassidyjames
cassidyjames marked this pull request as ready for review August 26, 2026 22:13
@cassidyjames
cassidyjames requested a review from a team as a code owner August 26, 2026 22:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant