Skip to content

Conversation

@fdevans
Copy link
Contributor

@fdevans fdevans commented Nov 5, 2025

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 rundeck repository. Changes from our private rundeckpro repository 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:

  • Fetches merged PRs from the private rundeckpro repository
  • Filters for customer-relevant changes (via release-notes/include label)
  • Generates a documentation page at /history/updates/
  • Produces RSS/Atom feeds for automated notifications
  • Tracks changes since the last self-hosted release automatically

Key Features

  • Automatic Baseline Tracking: Integrated with existing notes.mjs workflow - when you generate release notes, the PR feed baseline automatically updates
  • Template-Based: Uses Nunjucks templates (matching notes.mjs pattern) for easy content customization
  • Clean Output: Removes internal ticket prefixes (RUN-XXXX) from PR titles for customer readability
  • Optional Sections: Can extract specific sections from PR bodies (e.g., "Release Notes") for additional context
  • Consistent Patterns: Follows established project conventions for maintainability

Files Added

  • docs/.vuepress/generate-pr-feed.mjs - Main script
  • docs/.vuepress/pr-feed.md.nj - Editable Nunjucks template
  • docs/.vuepress/pr-feed-config.json - Release baseline tracker
  • docs/history/updates/index.md - Generated output page
  • PR-FEED-README.md - Comprehensive documentation

Files Modified

  • docs/.vuepress/notes.mjs - Auto-updates PR feed config on release
  • package.json - Added pr-feed npm script
  • README.md - Added reference to PR feed docs

Usage

# Weekly SaaS release process:
npm run pr-feed
git add docs/history/updates/ docs/.vuepress/public/feeds/
git commit -m "Update SaaS deployment feed"

Documentation

See PR-FEED-README.md for complete setup instructions, workflow integration, and best practices.

@fdevans fdevans requested review from a team and Copilot November 5, 2025 22:17
Copy link
Contributor

Copilot AI left a 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

@fdevans fdevans added this to the 5.18.0 milestone Nov 5, 2025
@fdevans fdevans requested a review from Copilot November 6, 2025 19:18
Copy link
Contributor

Copilot AI left a 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.

@fdevans fdevans changed the title Add Automated PR Feed Generator for SaaS Development Updates RUN-3921: Add Automated PR Feed Generator for SaaS Development Updates Nov 6, 2025
@fdevans fdevans requested review from Copilot and gschueler November 7, 2025 00:32
gschueler
gschueler previously approved these changes Nov 7, 2025
Copy link
Contributor

Copilot AI left a 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.

@fdevans fdevans requested a review from gschueler November 7, 2025 00:42
@fdevans fdevans merged commit dbb951e into 4.0.x Nov 7, 2025
1 check passed
@fdevans fdevans deleted the Pro-rss-feed branch November 7, 2025 00:51
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.

3 participants