Skip to content

docs: document releases, publishing and updating feed apps - #51

Merged
salmanfarisvp merged 1 commit into
developmentfrom
docs/release-and-feed-apps
Nov 4, 2026
Merged

salmanfarisvp merged 1 commit into
developmentfrom
docs/release-and-feed-apps

Conversation

@salmanfarisvp

Copy link
Copy Markdown
Member

Documents how this repo releases, and how to publish and update RSS-based feed apps, in the README.

Releasing

Tag-based releases already work here the same way as in the other Edge App repos. update-edge-app.yml is identical to air-quality-app's (shared update.yml@v26.10.2, v[0-9]* tags), and the feed-app workflow responds to the same tags. The README now says so:

  • Merging to main deploys the main app and every feed app to stage.
  • One vYY.M.PATCH tag on main deploys all of them to production.

The version format now matches the other repos (vYY.M.PATCH, previously vYY.MM.N here).

Publishing a new feed app

The steps: host an icon, add a deployed-apps.yml entry with empty ids, initialize on stage, record the id, check it, then do the same for production. The example entry leaves out categories, because the workflow doesn't apply it (feed apps are still listed as Utilities).

Updating a feed app

Covers which change goes where:

  • Name, description, icon, header title or feed URL: edit deployed-apps.yml.
  • Code or other settings: edit the code or screenly.yml. Every feed app picks it up.
  • One-off runs: use the manual workflow and its overrides.
  • Removing an app from deploys: clear its id.

It also notes that changing app_name after creation doesn't rename the app.

DEPLOYMENT.md

Keeps how the feed-app workflows work and the deployed-apps.yml field reference, and links to the README for the steps, so the two can't drift apart.

- Releasing explains that one vYY.M.PATCH tag on main releases the main
  app and every feed app with a production id, and uses the same version
  format as the other Edge App repos.
- New sections cover publishing a new feed app (icon, deployed-apps.yml
  entry, initialize on stage then production, record the ids) and
  updating one (deployed-apps.yml, code or screenly.yml, one-off runs,
  removing an app from deploys).
- DEPLOYMENT.md keeps how the feed-app workflows work and the field
  reference, and links to the README for the steps.
Copilot AI lite review requested due to automatic review settings November 4, 2026 06:55
@salmanfarisvp
salmanfarisvp merged commit e61a407 into development Nov 4, 2026
2 checks passed

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The supplied review evidence identifies no unresolved concerns in the changes.

No open issues 🎉

What changed in this PR

This pull request documents release procedures and the lifecycle of publishing and updating RSS feed apps, while keeping DEPLOYMENT.md focused on workflow and configuration references.

Changes:

  • Documents stage and production releases using vYY.M.PATCH tags.
  • Adds instructions for publishing, updating, testing, and removing feed apps.
  • Links deployment configuration guidance to the README.
File Summary
README.md Adds release and feed-app lifecycle documentation. Clarify that adding a feed-app entry and merging to main still triggers normal stage deployments, while an app without an ID is skipped and may cause the feed-app workflow to report “No apps to deploy.”
DEPLOYMENT.md Retains workflow and configuration context while linking to the README for operational procedures.
deployed-apps.yml Updates the configuration comment to direct contributors to the README.

This pull request requires changes.

Review effort: Lite

salmanfarisvp added a commit that referenced this pull request Nov 5, 2026
docs: document releases, publishing and updating feed apps
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.

2 participants