Skip to content

Conversation

@JakeSCahill
Copy link
Contributor

@JakeSCahill JakeSCahill commented Jul 17, 2025

This pull request includes several changes aimed at improving workflows, adding new functionality for fetching and saving Cloud API specifications, and updating documentation-related files. The most significant changes are grouped below by theme.

Check 'Determine overlays' here to see that it's working: https://github.com/redpanda-data/api-docs/actions/runs/16340767714/job/46162592679

Workflow Improvements:

  • Refactored the overlay handling logic in .github/workflows/bump.yml to simplify the process of appending overlay paths. The add_overlay function was removed, and the logic was replaced with for loops for both doc-specific and shared overlays. This eliminates the use of find and streamlines the code. [1] [2]

New Workflow for Cloud API Specs:

  • Added a new GitHub Actions workflow in .github/workflows/get-cloud-api-spec.yaml to fetch and save Cloud API specifications. This workflow includes steps for setting up AWS credentials, checking out the repository, installing dependencies, running scripts to fetch API specs, and creating a pull request with the updated specs.\

Relies on https://github.com/redpanda-data/devprod-infra/pull/303 and https://github.com/redpanda-data/cloudv2/pull/22775

Documentation Updates:

  • Updated the description of the AWS.Role schema in cloud-controlplane/cloud-controlplane.yaml to clarify its purpose.

Dependency Management:

  • Added a new package.json file for managing dependencies related to API documentation. This includes a dependency on @redpanda-data/docs-extensions-and-macros and metadata for the project.

@JakeSCahill JakeSCahill requested a review from a team as a code owner July 17, 2025 08:38
@github-actions
Copy link

github-actions bot commented Jul 17, 2025

ℹ️ API content change detected:

No structural change, nothing to display.

Preview documentation

Powered by Bump.sh

@JakeSCahill JakeSCahill merged commit 48f571a into main Jul 17, 2025
3 checks passed
@JakeSCahill JakeSCahill deleted the fix-action branch July 17, 2025 15:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants