Skip to content

Conversation

@JakeSCahill
Copy link
Contributor

This pull request introduces a new GitHub Actions workflow to automate the update of Admin API documentation in the docs repository whenever a new release is published. The workflow ensures that only the latest, non-draft, non-prerelease releases trigger the documentation update process.

New workflow for API documentation automation:

  • Added .github/workflows/dispatch-api-docs.yml to dispatch an event to the docs repository (redpanda-data/api-docs) when a new, latest release is published.
  • Workflow securely assumes an AWS role and fetches the ACTIONS_BOT_TOKEN from AWS Secrets Manager for authentication.
  • Includes a step to verify that the release is the latest before dispatching the update event, preventing updates from drafts or prereleases.
  • Uses the repository-dispatch action to notify the docs repository with the relevant release tag for documentation update.

Related: redpanda-data/api-docs#25

Backports Required

  • none - not a bug fix
  • none - this is a backport
  • none - issue does not exist in previous branches
  • none - papercut/not impactful enough to backport
  • v25.2.x
  • v25.1.x
  • v24.3.x

Release Notes

@JakeSCahill JakeSCahill requested a review from a team as a code owner October 8, 2025 11:48
@JakeSCahill JakeSCahill requested review from clee, Copilot and rockwotj and removed request for a team October 8, 2025 11:48
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds automation for updating Admin API documentation by introducing a GitHub Actions workflow that triggers when new releases are published. The workflow ensures only the latest, non-draft, non-prerelease releases trigger documentation updates in the docs repository.

Key changes:

  • New GitHub Actions workflow for automated API documentation updates
  • AWS authentication integration for secure token retrieval
  • Latest release verification to prevent unnecessary documentation updates

@rockwotj rockwotj merged commit 60c590b into dev Oct 8, 2025
10 of 11 checks passed
@rockwotj rockwotj deleted the DOC-1705 branch October 8, 2025 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants