[iarif4u]

Fixes #261.

Merge after #346 and #348. This README documents host-tools/testrunner.sh (#346) and host-tools/setup.sh (#348). I checked that all three branches merge together without conflicts.

Purpose

#259, #260 and #257 add a host-tools/ directory with scripts for hosts. This adds the documentation for it.

Changes

• New host-tools/README.md:
  • What each script does, and that neither one changes the runner's PHP files.
  • What you need before you start: a non-root user, a database only for the tests, and the required software.
  • Setup in 4 steps: clone, setup.sh, one run by hand, and cron. It also covers how to add the report API key later.
  • Reference for setup.sh: options, where the values come from, .env backup and file mode.
  • Reference for testrunner.sh: the steps, what happens when a step fails, the exit status, and the environment variables.
  • Short contributing notes for the scripts.
• Main README: one paragraph in "Quick setup" that points to the host tools for the "runner cloned on the server" setup.

All behavior in the README comes from the two scripts. One example: each run clones WordPress and installs the dependencies again, because cleanup.php deletes the checkout.

Contributed at WordCamp Contributor Day.

[github-actions]

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs.

Unlinked Accounts

The following contributors have not linked their GitHub and WordPress.org accounts: @iarif4u.

Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Unlinked contributors: iarif4u.

Co-authored-by: ekamran <ekamran@git.wordpress.org>
Co-authored-by: kittenkamala <amykamala@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

---

Props Bot commands

You can trigger Props Bot actions by commenting on this PR:

• @propsbot add <username> to give props to a GitHub user. Requires write access.
• @propsbot remove <username> to leave a user out of the props. Requires write access.
• @propsbot refresh to refresh this list. Adding the props-bot label works too.

[ekamran]

Thanks @iarif4u. I checked every line against #346 (41575c3) and #348 (9ab31b9). The steps, options, failure behavior and exit status all match the scripts, the links resolve, and "Test Reporter" is the role name in the reporter plugin.

The inline notes are mostly follow-ups from the open #346 and #348 review threads, so the docs stay aligned with the scripts if those changes land. Line 71 also needs the #348 change to be true for --non-interactive, details inline.

[ekamran]

Thanks @iarif4u. I checked every line against #346 (28be5d0) and #348 (41d62ea). The docs match the scripts, and the three PRs merge cleanly together.

[iarif4u]

Thanks @ekamran for the approval, and for checking the docs line by line against #346 and #348!

[kittenkamala]

Can merge with #348 and #346 once 346 is approved