Fix GitHub Action to pick up overlay paths#5
Merged
Merged
Conversation
|
ℹ️ API content change detected: No structural change, nothing to display.
|
kbatuigas
approved these changes
Jul 17, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
.github/workflows/bump.ymlto simplify the process of appending overlay paths. Theadd_overlayfunction was removed, and the logic was replaced withforloops for both doc-specific and shared overlays. This eliminates the use offindand streamlines the code. [1] [2]New Workflow for Cloud API Specs:
.github/workflows/get-cloud-api-spec.yamlto 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:
AWS.Roleschema incloud-controlplane/cloud-controlplane.yamlto clarify its purpose.Dependency Management:
package.jsonfile for managing dependencies related to API documentation. This includes a dependency on@redpanda-data/docs-extensions-and-macrosand metadata for the project.