atmos
atmos copied to clipboard
Add Announcements Blog
what
- Provide an area for announcements
why
- A lot is changing in atmos and following releases is difficult to get the big picture
Summary by CodeRabbit
- New Features
- Introduced a dedicated blog section for release notes with a clear title and description.
- Configured the blog to display release notes neatly with pagination (10 posts per page).
- Added a navigation link in the main menu to provide direct access to the blog section.
📝 Walkthrough
Walkthrough
Adds blog configuration and a welcome changelog post; introduces a GitHub Actions "Changelog Check" workflow enforcing blog-post changelogs for PRs labeled minor/major; documents the changelog entry requirement in CLAUDE.md.
Changes
| Cohort / File(s) | Change Summary |
|---|---|
Docusaurus blog configwebsite/docusaurus.config.js |
Added blog properties: postsPerPage: 10, blogTitle: 'Atmos Changelog', blogDescription: 'Release notes for Atmos', include: ['**/*.{md,mdx}']. |
New blog postwebsite/blog/welcome.md |
Added welcome/intro changelog post with frontmatter (slug/title/authors/tags) and body describing changelog purpose, sections, and links. |
Changelog enforcement CI.github/workflows/changelog-check.yml |
New workflow "Changelog Check" on pull_request: detects if changelog required via labels, diffs for new website/blog/*.{md,mdx} posts, posts/updates a standardized PR comment when missing, and fails when required changelog is absent. |
Docs: PR guidanceCLAUDE.md |
Added "Add changelog entry for feature releases" guidance (filename/frontmatter, <!--truncate-->, linking guidance) and minor wording adjustments; documents CI comment behavior. |
Sequence Diagram(s)
sequenceDiagram
participant Contributor
participant GitHubActions as GH Actions
participant Repo
participant PR
Contributor->>PR: Open or update PR (may add labels)
PR->>GitHubActions: Trigger changelog-check workflow
GitHubActions->>Repo: Inspect PR labels -> requires_changelog?
alt requires_changelog
GitHubActions->>Repo: Diff origin/base_ref..HEAD for website/blog/*.{md,mdx}
alt changelog found
GitHubActions->>PR: Mark job success
else missing changelog
GitHubActions->>PR: Post/update standardized comment (changelog-check)
GitHubActions->>PR: Fail job
end
else no changelog required
GitHubActions->>PR: Mark job success
end
sequenceDiagram
participant Visitor
participant DocusaurusSite
participant Blog
Visitor->>DocusaurusSite: Navigate to /blog
DocusaurusSite->>Blog: Render blog list (use config)
Blog->>Visitor: Display posts (10 per page), title "Atmos Changelog", description "Release notes for Atmos"
Estimated code review effort
🎯 3 (Moderate) | ⏱️ ~20 minutes
Possibly related PRs
- cloudposse/atmos#1419 — overlaps edits to
CLAUDE.mdand related documentation guidance. - cloudposse/atmos#1183 — related changes to
website/docusaurus.config.js(blog configuration edits).
Suggested reviewers
- aknysh
Pre-merge checks and finishing touches
❌ Failed checks (1 warning)
| Check name | Status | Explanation | Resolution |
|---|---|---|---|
| Title Check | ⚠️ Warning | The title “Add Announcements Blog” does not accurately or specifically reflect the main change, which is introducing an Atmos changelog blog (with configuration, documentation updates, a welcome post, and a CI check) rather than a general announcements blog, making it misleading and overly narrow. | Rename the title to clearly summarize the primary change, for example “Add Atmos Changelog Blog” or “Introduce Changelog Blog with Config, Docs, and CI Check.” |
âś… Passed checks (2 passed)
| Check name | Status | Explanation |
|---|---|---|
| Description Check | ✅ Passed | Check skipped - CodeRabbit’s high-level summary is enabled. |
| 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
- [ ] Commit unit tests in branch
202501-announcements
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.
Comment @coderabbitai help to get the list of available commands and usage tips.
Codecov Report
:white_check_mark: All modified and coverable lines are covered by tests.
:white_check_mark: Project coverage is 64.92%. Comparing base (70d9d12) to head (bb20050).
:warning: Report is 1 commits behind head on main.
Additional details and impacted files
@@ Coverage Diff @@
## main #1161 +/- ##
==========================================
+ Coverage 64.90% 64.92% +0.01%
==========================================
Files 337 337
Lines 37472 37472
==========================================
+ Hits 24322 24329 +7
+ Misses 11204 11196 -8
- Partials 1946 1947 +1
| Flag | Coverage Δ | |
|---|---|---|
| unittests | 64.92% <ø> (+0.01%) |
:arrow_up: |
Flags with carried forward coverage won't be shown. Click here to find out more. see 4 files with indirect coverage changes
:rocket: New features to boost your workflow:
- :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
[!IMPORTANT]
Cloud Posse Engineering Team Review Required
This pull request modifies files that require Cloud Posse's review. Please be patient, and a core maintainer will review your changes.
To expedite this process, reach out to us on Slack in the
#pr-reviewschannel.
These changes were released in v1.195.0-test.0.