Skip to content

Add test for new README.md in docs

Achilleas Pipinellis - OOO until November 25th (parental leave) requested to merge docs/add-test-for-readmes into master

What does this MR do?

Adds a test to check whether new README.md files are added in docs, as we prefer using index.md. That's a silly implementation which compares the number of readmes to a fixed number.

It currently outputs:

=> Checking for cURL short options...
=> Checking for CHANGELOG.md duplicate entries...
=> Checking for executable permissions...
=> Checking for new README.md files...

  ✖ ERROR: New README.md file(s) detected, prefer index.md over README.md.
  https://docs.gitlab.com/ee/development/writing_documentation.html#location-and-naming-documents

What are the relevant issue numbers?

Closes https://gitlab.com/gitlab-org/gitlab-ce/issues/44647

Merge request reports