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

[Paul123111]

Describe your changes

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.

Relevant Jira

https://issues.redhat.com/browse/RELEASE-1675

Checklist before requesting a review

• I have marked as draft or added do not merge label if there's a dependency PR
  • If you want reviews on your draft PR, you can add reviewers or add the release-service-maintainers handle if you are unsure who to tag
• My commit message includes Signed-off-by: My name <email>
• I read CONTRIBUTING.MD and commit formatting

[Paul123111]

I split up this PR into five parts to try to get tests to pass

Original PR here: #1147

[Paul123111]

Some of the comments on this PR would also apply to test_tekton_tasks.sh

[Paul123111]

Added check_param_punctuation.sh and workflow from Martin's comment in one of the other PRs.

[johnbieren]

The error messages in the script look good, but can you also please add a note in CONTRIBUTING.md about the script? Under the submitting changes section? Bonus points if you add a bullet point to pull_request_template.md like I have run the README.md generator script in .github/scripts/readme_generator.sh

[johnbieren]

The error messages in the script look good, but can you also please add a note in CONTRIBUTING.md about the script? Under the submitting changes section? Bonus points if you add a bullet point to pull_request_template.md like I have run the README.md generator script in .github/scripts/readme_generator.sh

As part of the CONTRIBUTING.md update, you should also say where the changes should be made. Should I update the parameter in the yaml or the README? Which one takes priority? Same for the overall description (I know we said to use the README for source of truth to update them all, but once that is done, perhaps the yaml should be source of truth for everything and we will never have to manually touch the README.md files)

[Paul123111]

I had a note in CONTRIBUTING.md, looks like I forgot to push it when I was updating these PRs - I added it back in

The yaml files are the source of truth for the README, we shouldn't have to manually update the README.md files at all. A lot of ways to update yaml files in the CLI (such as yq) break formatting (for example, any descriptions with > get folded into one line in the yaml file, failing yamllint) in some places, so I think it would be better if the yaml files were the source of truth rather than the README.

[johnbieren]

Sean and Fitz already approved the bash scripts, so I didn't review those two files. But I will mark this PR approved once my one comment is addressed

[Paul123111]

There were some minor changes to the bash scripts after they reviewed it (mainly just a few changes to the error messages), but otherwise it should be fine

[openshift-ci]

New changes are detected. LGTM label has been removed.