DOC-1409 Add CI/CD pipeline for deploying and previewing API docs

[JakeSCahill]

This pull request introduces a new GitHub Actions workflow to automate the deployment and diff-checking of API documentation using Bump.sh. The workflow is triggered on pushes and pull requests to the main branch and includes three main jobs: determining affected API documentation, deploying updated documentation, and checking API diffs for pull requests.

New GitHub Actions Workflow for API Documentation

• Workflow Trigger and Permissions: The workflow, defined in .github/workflows/bump.yml, is triggered on pushes and pull requests to the main branch and includes permissions for reading repository contents and writing pull request comments.

• Determine Affected Documentation: The determine-doc-ids job identifies which API documentation folders (admin, cloud-controlplane, cloud-dataplane, schema-registry, http-proxy) have changes. It also accounts for shared resources that might impact multiple APIs and generates a matrix of affected documentation IDs.

• Deploy Updated Documentation: The deploy-doc job deploys updated API documentation to Bump.sh for affected APIs. It determines the appropriate file format (YAML or JSON) and applies overlays specific to the API or shared resources.

• Check API Diffs: The api-diff job runs during pull requests to check for API differences using Bump.sh.

[github-actions]

🤖 API structural change detected:

Modified (4)

• GET /v1/clusters
  • Response modified: 200
    • Content type modified: application/json
      • Property modified: clusters
        • Property modified: customer_managed_resources
• GET /v1/clusters/{id}
  • Response modified: 200
    • Content type modified: application/json
      • Property modified: cluster
        • Property modified: customer_managed_resources
• PATCH /v1/clusters/{cluster.id}
  • Content type modified: application/json
    • Property modified: customer_managed_resources
      • Property modified: gcp
        • Property added: psc_v2_nat_subnet_name
    • Property added: cloud_storage
  • Response modified: 202
    • Content type modified: application/json
      • Property modified: customer_managed_resources
        • Property modified: gcp
      • Property added: cloud_storage
• POST /v1/clusters
  • Content type modified: application/json
    • Property modified: cluster
      • Property modified: customer_managed_resources
        • Property modified: gcp
      • Property added: cloud_storage

Preview documentation

Powered by Bump.sh