Skip to content

[feature] Add local docs versioning command for release validation #1355

@viiccwen

Description

@viiccwen

What

Add a local docs versioning command for release validation.

Contributors should be able to generate versioned API documentation from an explicit version string before any tag-triggered automation is enabled.

Why

Release documentation has higher risk than normal preview builds because it affects published versioned docs. A local command lets maintainers validate the Docusaurus versioning flow and generated API docs output before adding GitHub Actions automation.

This creates a safer path toward release/tag integration.

How

Add and document a local versioning workflow for API docs.

The update should:

  • add a local command or script that accepts an explicit version string
  • generate versioned docs output compatible with the Docusaurus website
  • validate the generated versioned docs locally
  • document how contributors or release managers can test the flow
  • keep the behavior deterministic and easy to review

Out of scope:

  • tag-triggered GitHub Actions automation
  • committing generated versioned docs from CI
  • deploying the website
  • deciding ASF release/deploy policy in code without maintainer agreement

Parent roadmap: #1361

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    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