feat(RELEASE-1725): auto generate README.md files for tasks/pipelines

[Paul123111]

Add readme_generator.sh, which generates README.md files for tasks and pipelines, as well as a check_readme.sh script and workflow to check that the README.md files in each task and pipeline match the output of readme-generator.sh.

Also updated all README.md files using this script.

[Paul123111]

Changed PR and commit title because of new ticket

[johnbieren]

Are the two bash scripts exactly the same as the ones in release-service-catalog (to save review time)? Can you update the contributing doc?

[Paul123111]

Yeah, I'm waiting for the scripts to be approved in release-service-catalog (konflux-ci/release-service-catalog#1157) - I will copy them over once they are merged, these scripts are outdated. I marked it as work-in-progress to stop people from reviewing the same script twice.

I was also planning to add the contributing doc in the PR for https://issues.redhat.com/browse/RELEASE-1493 and include the automatic README in that.

[johnbieren]

Yeah, I'm waiting for the scripts to be approved in release-service-catalog (konflux-ci/release-service-catalog#1157) - I will copy them over once they are merged, these scripts are outdated. I marked it as work-in-progress to stop people from reviewing the same script twice.

I was also planning to add the contributing doc in the PR for https://issues.redhat.com/browse/RELEASE-1493 and include the automatic README in that.

Are they the same now?

[Paul123111]

They should be the same now, except for a failsafe to skip test directories in check_readme.sh, and changing the scripts and workflow to account for how tasks/pipelines are kept as tasks/task-name instead of tasks/managed/task-name.

[johnbieren]

They should be the same now, except for a failsafe to skip test directories in check_readme.sh, and changing the scripts and workflow to account for how tasks/pipelines are kept as tasks/task-name instead of tasks/managed/task-name.

aka not the same 😅

[Paul123111]

yeah 😅

[Paul123111]

/lgtm

Just testing to make adding LGTM to my own PR isn't possible

[openshift-ci]

@Paul123111: you cannot LGTM your own PR.

Details

In response to this:

/lgtm

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.

[Paul123111]

Also, is this PR ready to be merged or does it need some more changes? There aren't any unresolved conversations

[johnbieren]

Also, is this PR ready to be merged or does it need some more changes? There aren't any unresolved conversations

I don't have any more changes to ask for but others should review it too

[FilipNikolovski]

This lgtm, apart from the unresolved comments from @theflockers.

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Paul123111, theflockers

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

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [Paul123111,theflockers]

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