Skip to content

[Feature]: trigger docs publish on release tags, auto-register and prune versions #935

Description

@pdmack

Prerequisites

  • I searched existing issues and found no duplicates

Feature Summary

The publish-fern-docs workflow currently triggers on docs/v* tags, which requires a separate manual tag push for docs publishing. Release tags (v1.2.0) already represent documentation milestones and should drive docs publishing automatically.

Problem/Use Case

  1. Docs publishing requires a separate docs/v* tag push — easy to forget, out of sync with releases
  2. No automatic version registration — new versions must be manually added to fern/docs.yml
  3. No version pruning — old versions accumulate indefinitely

Proposed Solution

  • Trigger on release tags (v[0-9]*.[0-9]*.[0-9]*) instead of docs/v*
  • On release tag push, auto-generate fern/versions/vX.Y.Z.yml and add to docs.yml
  • Prune older versions to keep only the 3 most recent (plus Latest)
  • Pre-release tags (e.g. v1.6.0-rc1) trigger publish but skip version registration
  • Commit version changes back to main

Adapted from NVIDIA/NVSentinel#1292.

Success Criteria

  • Release tags trigger docs publish
  • Pre-release tags publish without registering a version
  • Version files auto-generated and committed to main
  • Old versions pruned to keep 3 most recent

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions