Automate developers.konghq.com PR creation during release

[pmalek]

Problem statement

Similarly to KIC, KGO now has a makefile target and scripts that auto generate CLI arguments docs based on config flags from https://github.com/Kong/gateway-operator/blob/7390dcf2e1cebb7eb08c4c1f8af0e3a084423034/modules/cli/cli.go.

This issue tracks the effort of automating PR creation during releases.

Relevant

• This can be inspired by
  • https://github.com/Kong/kong-mesh/blob/8fc4be8ffe4ace32869692cb1faaf8556347cc8e/.github/workflows/kuma-update-docs.yaml
  • https://github.com/Kong/kubernetes-ingress-controller/blob/ef2b59f84ba4d3f1deb29b2cfca16e8c4f8e28ae/.github/workflows/release_docs.yaml

Acceptance criteria

• An action runs on a cron (daily?) to push generated docs to the docs repo for the main branch
• Release checklist removes steps that require syncing these generated files
• [ ] An issue to replicate this setup is created for KIC
  • Not relevant anymore with KO nearing its release
• Do not forget to take into account the "entreprise" duality (xref: https://github.com/Kong/gateway-operator-enterprise/issues/107)
  • Not relevant anymore with sunsetting EE

[pmalek]

A prototype for this is pushed to https://github.com/Kong/gateway-operator/tree/cli-flags.

PR preview: https://github.com/Kong/gateway-operator/compare/cli-flags?expand=1

[lahabana]

During this KIC's release (which as a similar setup). We discussed doing the sync on a cron basis for the main branch so the going would be always up to date. I think that's what we should aim for.