-
Notifications
You must be signed in to change notification settings - Fork 11.3k
Add automated RSS feed generation #2125
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
base: main
Are you sure you want to change the base?
Conversation
Introduces a Python script to generate an RSS feed from registry.yaml and authors.yaml, a GitHub Actions workflow to automate feed updates on main branch changes, and adds the generated rss.xml file. Updates README to include RSS subscription link.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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 automated RSS feed generation for the OpenAI Cookbook, making it easier for users to subscribe to updates without manually watching the repository. The implementation builds an RSS 2.0 feed from existing YAML data and publishes it automatically via GitHub Actions.
- Automated RSS feed generation from
registry.yaml
andauthors.yaml
data - GitHub Actions workflow for automatic feed updates on every push to main
- Documentation update advertising the RSS feed URL to users
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
File | Description |
---|---|
.github/scripts/generate_rss.py |
Python script that builds RSS 2.0 feed from YAML data with proper metadata and Dublin Core namespaces |
.github/workflows/generate-rss.yaml |
GitHub Actions workflow that runs RSS generation and commits updates automatically |
README.md |
Adds RSS feed subscription link for user visibility |
rss.xml |
Generated RSS feed artifact containing all cookbook entries with metadata |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: paytonison <148833579+paytonison@users.noreply.github.com>
Fix duplicate namespace declarations in RSS feed XML generation
Add auto-generated RSS feed for new/updated Cookbook content
Summary
This PR introduces an automated RSS (Atom-compatible) feed so users can subscribe to Cookbook updates without watching the repo or checking manually.
rss.xml
fromregistry.yaml
+authors.yaml
main
via GitHub ActionsChanges
.github/scripts/generate_rss.py
rss.xml
(UTF-8, XML declaration)archived: true
<category>
and authors →dc:creator
lastBuildDate
to newest entry date (or now UTC if none).github/workflows/generate-rss.yaml
main
andworkflow_dispatch
pyyaml
, runs the generator, commitsrss.xml
if changedREADME.md
rss.xml
at repo root (auto-updated by CI)Motivation
Many users prefer a feed reader to track new tutorials, examples, and significant docs revisions. GitHub “Watch → All activity” is noisy; an RSS feed is low-friction and standard.
Implementation details
registry.yaml
(plusauthors.yaml
)/blob/main/<path>
) for stability.title
,pubDate
from entry dateguid
is a permalink to the blob URLdescription
includes Tags and Authorsdc:creator
for each authordc
namespace for creators.Feed location
(If desired later, the website can serve https://cookbook.openai.com/rss.xml by copying this file during build/deploy.)
Testing
Local
This pull request introduces automated generation and publishing of an RSS feed for the OpenAI Cookbook, making it easier for users to subscribe to updates. The main changes include adding a Python script to build the RSS feed from existing data, setting up a GitHub Actions workflow to run this script and publish
rss.xml
on every push tomain
, and updating documentation to advertise the RSS feed.RSS Feed Generation and Automation:
.github/scripts/generate_rss.py
, a Python script that readsregistry.yaml
andauthors.yaml
to generate an RSS 2.0 feed (rss.xml
). The feed includes metadata, links to source files, and skips archived items..github/workflows/generate-rss.yaml
, a GitHub Actions workflow that runs the RSS generation script on pushes tomain
, installs dependencies, and commits/pushes updates torss.xml
if there are changes.Documentation Update:
README.md
to include a link to the new RSS feed, allowing users to easily subscribe to cookbook updates.