Skip to content

Open Source Update Strategy | Phase 2 | Document release subscription paths #551

@giverm

Description

@giverm

User story

As a state implementer running an OSCER deployment, I want documented subscription paths to OSCER releases so that I can opt into release notifications using GitHub's built-in mechanisms without having to discover them on my own — and so that I know where breaking-change and security-patch information will surface.

Context

Once #531 establishes tagged releases, GitHub exposes the Releases page on template-strata-oscer-app as a canonical, auto-updated source-of-truth at no Nava-side cost. Implementers can subscribe via GitHub's "Watch → Custom → Releases" UI and receive notifications through GitHub's standard channels (web, email, mobile push). The mechanism is mature, well-understood, and zero-infrastructure.

The Nava precedent supports treating this as sufficient for v1: navapbc/template-application-rails has shipped tagged releases for over a year (v0.4.0 in March 2025 through v1.0.0 in May 2026) with no notification infrastructure beyond GitHub Releases — no Discussions, no announce-on-release workflow, no mailing list, no repository_dispatch fan-out. There is no documented case where this baseline has failed an implementer.

This ticket therefore scopes narrowly to documenting the subscription path rather than building a notification system. The strategy doc's broader notification surface — Channel 2 broadcast venues, automated announcement workflow, cross-repo dispatch — is deferred to follow-up tickets gated on actual implementer demand. The decision is YAGNI-aligned: GitHub's built-in mechanisms cover the use case today; speculative infrastructure is filed as future work, not built now.

Strategy detail: #213 Section 3 (Notification channels) + Section 7 Phase 2.

Effort estimate: ~0.5 day. Doc edits in two locations + a verification pass on a sample release from #531 to confirm it renders readably in GitHub's notification surfaces.

Prerequisites

Sequencing

Independent of other Phase 2 work; can be done in parallel.

Scope

In this ticket:

Out of this ticket:

  • Additional notification methods. Anything beyond GitHub's built-in Watch + Releases is out of scope and can be added as a follow-up if demand arises.

Acceptance criteria

Part of #527.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    Status
    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions