CF API openapi spec is not published automatically

[stephanme]

Issue

CF API openapi spec is not published to https://v3-apidocs.cloudfoundry.org/openapi automatically.

Context

The CF API openapi spec was copied into cloud_controller_ng with #5287

It is supposed to be published to https://v3-apidocs.cloudfoundry.org/openapi

There are two github workflows involved:

• Deploy CF API V3 OpenAPI Documentation - which builds the openapi docs and copies them to the gh-pages branch
• Deploy V3 API Docs to Pages - which publishes the content of the gh-pages branch to the web site

Now there is a github actions limitation that commits made by GITHUB_TOKEN of a workflow won't trigger additional workflows.

Steps to Reproduce

1. make a change to the openapi spec sources
2. observe that workflow Deploy CF API V3 OpenAPI Documentation runs
3. observe that workflow Deploy V3 API Docs to Pages does not run
4. observe that https://v3-apidocs.cloudfoundry.org/openapi is not updated

Expected Result

Changed openapi spec gets published to https://v3-apidocs.cloudfoundry.org/openapi

Current Result

https://v3-apidocs.cloudfoundry.org/openapi is not updated

Possible Fix

Options:

• use a PAT instead of the GITHUB_TOKEN to commit the new spec to the gh_pages branch
• call the Deploy V3 API Docs to Pages explicitly in Deploy CF API V3 OpenAPI Documentation, see Reuse workflows