PF-174: Document how customers can track the latest releases in Pipelines#3119
PF-174: Document how customers can track the latest releases in Pipelines#3119gruntwork-ci wants to merge 3 commits intomainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughAdds "Pipelines release notifications" sections to the updating-pipelines guide for both GitHub and GitLab, documenting Releases/“Release is created” notification setup, Atom feed endpoints ( ChangesPipelines Release Notifications
Estimated Code Review Effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 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. 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 |
|
|
||
| :::note | ||
|
|
||
| Dependabot (mentioned above) also surfaces new releases by opening pull requests against your repository. The Atom feed is a lower-latency complement: it notifies you as soon as a release is published, before a bot opens the upgrade PR. |
There was a problem hiding this comment.
I don't think we actively set this up for customers
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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/2.0/docs/pipelines/guides/updating-pipelines.md`:
- Line 26: The two duplicate "### Pipelines Release Notifications" headings
should be made unique and aligned in hierarchy: change each to a higher-level
"##" and append a platform-specific label (e.g., "## Pipelines Release
Notifications — Cloud" and "## Pipelines Release Notifications — On‑Prem" or
similar) so the headings are distinct and the level progression is correct;
update any internal cross-links or references that pointed to the old heading
text to match the new headings.
- Around line 30-32: The two fenced code blocks containing the URLs
"https://github.com/gruntwork-io/pipelines-workflows/releases.atom" and
"https://gitlab.com/gruntwork-io/pipelines-workflows/-/releases.atom" are
missing language identifiers; update each triple-backtick fence to include a
language tag (e.g., change ``` to ```text) so the blocks read ```text ... ``` to
resolve markdownlint warnings.
🪄 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: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: ad7b8dc1-8781-4f93-aec4-840e7c8c40ae
📒 Files selected for processing (1)
docs/2.0/docs/pipelines/guides/updating-pipelines.md
| Gruntwork recommends leaving your workflow reference at a major-tag shorthand, such as `v3` to automatically get the latest minor-tag updates. | ||
| ::: | ||
|
|
||
| ### Pipelines Release Notifications |
There was a problem hiding this comment.
Fix heading hierarchy and duplicate heading text
Both new sections use the same ### heading text, which triggers heading-structure and duplicate-heading lint warnings. Please make these headings unique and align the level progression (for example, promote to ## and add platform-specific labels).
Suggested patch
-### Pipelines Release Notifications
+## Pipelines Release Notifications (GitHub)
...
-### Pipelines Release Notifications
+## Pipelines Release Notifications (GitLab)Also applies to: 68-68
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 26-26: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
🤖 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/2.0/docs/pipelines/guides/updating-pipelines.md` at line 26, The two
duplicate "### Pipelines Release Notifications" headings should be made unique
and aligned in hierarchy: change each to a higher-level "##" and append a
platform-specific label (e.g., "## Pipelines Release Notifications — Cloud" and
"## Pipelines Release Notifications — On‑Prem" or similar) so the headings are
distinct and the level progression is correct; update any internal cross-links
or references that pointed to the old heading text to match the new headings.
| To stay informed about new releases of Gruntwork Pipelines, subscribe to the GitHub Atom feed for the [`gruntwork-io/pipelines-workflows`](https://github.com/gruntwork-io/pipelines-workflows) repository: | ||
|
|
||
| ``` | ||
| https://github.com/gruntwork-io/pipelines-workflows/releases.atom | ||
| ``` | ||
|
|
||
| There are several ways to consume this feed: |
There was a problem hiding this comment.
Ordering seems off to me. If this works only for the dedicated RSS reader option, why show as top level and then have to refer to it later? Shouldn't it just be colocated with the option?
| - **GitHub's built-in watch**: Open the [`pipelines-workflows`](https://github.com/gruntwork-io/pipelines-workflows) repository, click **Watch**, choose **Custom**, and enable **Releases**. GitHub will email you when a new release is published. This is the lowest-friction option and does not require a feed reader. | ||
| - **A standalone RSS reader**: Add the feed URL above to a reader such as Feedly, NetNewsWire, or Inoreader. | ||
| - **Slack or Microsoft Teams**: Both platforms can post RSS items to a channel (Slack via its `/feed` slash command, Teams via an RSS connector). This lets release announcements land directly in a shared channel. | ||
|
|
There was a problem hiding this comment.
Make ordering of options consistent with GitLab below(not prescribing one or the other). It appears to me that there are two main options: Platform Notifications and RSS feed. The RSS feeds can be used in different ways.
There was a problem hiding this comment.
♻️ Duplicate comments (1)
docs/2.0/docs/pipelines/guides/updating-pipelines.md (1)
26-26:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix heading level jump at this section start
This heading still jumps from
#to###(MD001). Promote this section to##so hierarchy increments correctly; if you do that, make sibling section levels consistent in this tab as well.Suggested minimal patch
-### Pipelines release notifications (GitHub) +## Pipelines release notifications (GitHub)🤖 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/2.0/docs/pipelines/guides/updating-pipelines.md` at line 26, The heading "Pipelines release notifications (GitHub)" is using ### which causes a level jump; change that heading token to ## to restore correct hierarchy and then scan sibling headings in this document/tab to ensure their levels are consistent with the promoted ## (adjust other ###/#### as needed so top-level sections use ## and subsections use ### consistently).
🤖 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.
Duplicate comments:
In `@docs/2.0/docs/pipelines/guides/updating-pipelines.md`:
- Line 26: The heading "Pipelines release notifications (GitHub)" is using ###
which causes a level jump; change that heading token to ## to restore correct
hierarchy and then scan sibling headings in this document/tab to ensure their
levels are consistent with the promoted ## (adjust other ###/#### as needed so
top-level sections use ## and subsections use ### consistently).
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 2d5578b7-2319-4c7c-a580-88d70f5d262b
📒 Files selected for processing (1)
docs/2.0/docs/pipelines/guides/updating-pipelines.md
|
@oredavids I reviewed by hand, should be g2g now |
There was a problem hiding this comment.
♻️ Duplicate comments (1)
docs/2.0/docs/pipelines/guides/updating-pipelines.md (1)
26-26:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winUse unique heading text and fix heading level jump
At Line 26 and Line 70, the identical
### Pipelines release notificationsheadings still trigger duplicate-heading lint, and###also jumps from the document#level. Please make both headings unique and move them to##(or otherwise ensure valid progression).Suggested minimal patch
-### Pipelines release notifications +## Pipelines release notifications (GitHub) ... -### Pipelines release notifications +## Pipelines release notifications (GitLab)Also applies to: 70-70
🤖 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/2.0/docs/pipelines/guides/updating-pipelines.md` at line 26, Replace both duplicate "### Pipelines release notifications" headings with unique, descriptive headings and bump their level from "###" to "##" so heading depth progresses properly; locate the two occurrences of the exact heading string "Pipelines release notifications" in the document and change one (or both) to distinct titles (for example "## Pipelines release notifications" and "## Pipelines release notification schedule" or similar) to resolve the duplicate-heading lint and fix the level jump.
🤖 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.
Duplicate comments:
In `@docs/2.0/docs/pipelines/guides/updating-pipelines.md`:
- Line 26: Replace both duplicate "### Pipelines release notifications" headings
with unique, descriptive headings and bump their level from "###" to "##" so
heading depth progresses properly; locate the two occurrences of the exact
heading string "Pipelines release notifications" in the document and change one
(or both) to distinct titles (for example "## Pipelines release notifications"
and "## Pipelines release notification schedule" or similar) to resolve the
duplicate-heading lint and fix the level jump.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 87ac5c1a-1522-40ac-b147-2351ddde5efb
📒 Files selected for processing (1)
docs/2.0/docs/pipelines/guides/updating-pipelines.md
3 participants
Implements plan for Linear issue PF-174.
Plan source: https://github.com/gruntwork-io-team/linear-claude-plans/blob/main/plans/PF-174.md
Claude's implementation summary
Summary by CodeRabbit