Skip to content

[ci] Generate versioned API docs from release tags #1356

@viiccwen

Description

@viiccwen

What

Generate versioned API documentation from release tags.

After the local versioning flow and release policy are agreed, add tag-triggered automation for versioned API docs.

Why

Versioned API documentation should match Mahout releases, but automation around tags, generated files, and website deployment needs explicit review. Separating this issue keeps high-permission release workflows out of earlier validation and preview work.

This issue should make the write/deploy behavior clear before it is enabled.

How

Add tag-triggered versioning automation based on the validated local versioning command.

The update should:

  • trigger the workflow from the agreed release tag pattern
  • generate versioned API docs using the local versioning command
  • make required GitHub Actions permissions explicit and minimal
  • document whether generated files are committed, uploaded as artifacts, or deployed through the ASF website flow
  • validate behavior against the agreed Mahout/ASF release documentation policy

Out of scope:

  • changing the local docs generation architecture unnecessarily
  • adding broad write permissions without justification
  • changing release policy without maintainer agreement
  • normal PR preview artifact uploads

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