CI: add sync CRD reference step

[tao12345666333]

What this PR does / why we need it:

Which issue this PR fixes

Fixes #35

Special notes for your reviewer:

PR Readiness Checklist:

Complete these before marking the PR as ready to review:

• the CHANGELOG.md release notes have been updated to reflect significant changes

[pmalek]

Actually there's one caveat: this should only happen for releases that are marked as latest.

Otherwise, if we already released 2.1, we'll overwrite the CRDs with 2.0.7.

[tao12345666333]

Actually there's one caveat: this should only happen for releases that are marked as latest.

Yes, once #2642 is merged, will that mitigate this issue?

Or, I can add a check to see whether the latest has been set?

[pmalek]

Actually there's one caveat: this should only happen for releases that are marked as latest.

Yes, once #2642 is merged, will that mitigate this issue?

Or, I can add a check to see whether the latest has been set?

#2642 will only make sure that links are version aware. If the scenario I mentioned above happens, docs specific for 2.1 would get removed.

[tao12345666333]

@pmalek, sorry for the delay. The current workflow already has a condition that checks whether it is the latest, so it will only run when latest is set.

 create-docs-pr:
    runs-on: ubuntu-latest
    if: ${{ inputs.latest }}

https://github.com/Kong/kong-operator/pull/2775/changes#diff-88c290694df2f071e377f4435912af49059b0289f9bfc24a1a90eca2949ebaf4R361

Are there any other changes I need to make in this PR to move it forward? Thank you!

[pmalek]

@pmalek, sorry for the delay. The current workflow already has a condition that checks whether it is the latest, so it will only run when latest is set.

 create-docs-pr:
    runs-on: ubuntu-latest
    if: ${{ inputs.latest }}

https://github.com/Kong/kong-operator/pull/2775/changes#diff-88c290694df2f071e377f4435912af49059b0289f9bfc24a1a90eca2949ebaf4R361

Are there any other changes I need to make in this PR to move it forward? Thank you!

Ok that's good. I think in that case we can merge it. One tiny thing I'd change here is to add a description to the latest flag at

kong-operator/.github/workflows/__release-workflow.yaml

Lines 39 to 42 in d264fb9

	latest:
	description: Whether to mark this release latest
	type: boolean
	default: false

so that latest is not set to true if a newer major or minor has been released.

This means that if 2.2 has been released, and we're releasing 2.1.1 latest should not be set. Otherwise the docs will be overwritten which is not what we'd want. Do you agree?

[tao12345666333]

Yes, I agree. We should only set latest to true when the released version number is the current maximum. 35468b0