Add prow job in BMO to generate CR documentation

[MahnoorAsghar]

Add prow job in BMO to generate CR documentation; and
Revert #1107 'Install podman in basic-checks container'
This should work alongside metal3-io/baremetal-operator#2605

[metal3-io-bot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign kashifest for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[tuminoid]

This will generate the doc, but its missing the part where it detects if something has changed. That is easier to implement if you look at the existing hack/ scripts how they deal with local run and the prow run.

[MahnoorAsghar]

This will generate the doc, but its missing the part where it detects if something has changed. That is easier to implement if you look at the existing hack/ scripts how they deal with local run and the prow run.

@tuminoid I see that the pattern in hack/ is to launch a podman container, and once in it we execute a command, but I didn't understand what you meant by the detecting if something has changed part? Does the 'run_if_changed' prow argument not take care of that?
(I can ofcourse add a script to the hack/ directory for consistency or benefits)

[tuminoid]

This will generate the doc, but its missing the part where it detects if something has changed. That is easier to implement if you look at the existing hack/ scripts how they deal with local run and the prow run.

@tuminoid I see that the pattern in hack/ is to launch a podman container, and once in it we execute a command, but I didn't understand what you meant by the detecting if something has changed part? Does the 'run_if_changed' prow argument not take care of that? (I can ofcourse add a script to the hack/ directory for consistency or benefits)

The point of crdoc generation in tests is to see if rerunning it produces a diff, which would mean the author did not include the updated documentation in their PR. So it needs to fulfill two things:

1. allow developer to generate the updated API docs and add it to their PR
2. re-generate the API docs in prow, and FAIL if there was any change

[tuminoid]

Also needs to run if the gen-api-docs.sh script itself changes, so we validate it doesn't break. Sorry forgot that one first time around.

[tuminoid]

One more comment, and also please fix the commit and PR title and description.

[tuminoid]

/override metal3-ubuntu-e2e-integration-test-main

[metal3-io-bot]

@tuminoid: Overrode contexts on behalf of tuminoid: metal3-ubuntu-e2e-integration-test-main

In response to this:

/override metal3-ubuntu-e2e-integration-test-main

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[tuminoid]

/hold
until metal3-io/baremetal-operator#2605 is completed