-
Notifications
You must be signed in to change notification settings - Fork 164
RUN-3921: Add Automated PR Feed Generator for SaaS Development Updates #1718
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR introduces a new automated system for generating RSS/Atom feeds and documentation pages that track recent pull request merges from the private rundeckpro repository. The system helps communicate SaaS deployment updates to customers.
Key changes:
- Added a PR feed generator script that fetches recent PRs from GitHub and generates feeds
- Integrated the feed generator with the existing release notes workflow
- Created documentation for the new feed system
Reviewed Changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| package.json | Added npm script to run the PR feed generator |
| docs/history/updates/index.md | Generated example output showing recent development updates |
| docs/.vuepress/sidebar-menus/history.ts | Added "Recent Changes" link to the history sidebar menu |
| docs/.vuepress/public/feeds/development.xml | Generated RSS feed file |
| docs/.vuepress/public/feeds/development-atom.xml | Generated Atom feed file |
| docs/.vuepress/pr-feed.md.nj | Nunjucks template for generating the updates markdown page |
| docs/.vuepress/pr-feed-config.json | Configuration file tracking the last self-hosted release |
| docs/.vuepress/notes.mjs | Updated to automatically update PR feed config when creating release notes |
| docs/.vuepress/generate-pr-feed.mjs | Main script that fetches PRs and generates feeds and markdown |
| docs/.vuepress/config.ts | Updated icon assets configuration to include brand icons |
| README.md | Added documentation section about the SaaS development updates feed |
| PR-FEED-README.md | Comprehensive documentation for the PR feed generator |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 16 out of 16 changed files in this pull request and generated 1 comment.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 17 out of 17 changed files in this pull request and generated 7 comments.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Add Automated PR Feed Generator for SaaS Development Updates
!! Note: Before merge we need to update the config file to the latest release. Current setting is intentionally old so we see entries since 5.16.0.
Summary
Implements an automated system to generate customer-facing documentation of changes deployed to the Runbook Automation SaaS platform. This addresses the visibility gap for private repository changes that aren't yet available in self-hosted releases.
Problem
When we deploy to SaaS (typically weekly), customers only see updates from the public
rundeckrepository. Changes from our privaterundeckprorepository remain invisible until the next self-hosted release, leaving customers unaware of improvements and fixes they're already using.Solution
Created
generate-pr-feed.mjs- a script that:rundeckprorepositoryrelease-notes/includelabel)/history/updates/Key Features
notes.mjsworkflow - when you generate release notes, the PR feed baseline automatically updatesnotes.mjspattern) for easy content customizationFiles Added
docs/.vuepress/generate-pr-feed.mjs- Main scriptdocs/.vuepress/pr-feed.md.nj- Editable Nunjucks templatedocs/.vuepress/pr-feed-config.json- Release baseline trackerdocs/history/updates/index.md- Generated output pagePR-FEED-README.md- Comprehensive documentationFiles Modified
docs/.vuepress/notes.mjs- Auto-updates PR feed config on releasepackage.json- Addedpr-feednpm scriptREADME.md- Added reference to PR feed docsUsage
Documentation
See
PR-FEED-README.mdfor complete setup instructions, workflow integration, and best practices.