Skip to content

Document the host tools - #349

Open
iarif4u wants to merge 2 commits into
WordPress:masterfrom
iarif4u:docs/host-tools-readme
Open

iarif4u wants to merge 2 commits into
WordPress:masterfrom
iarif4u:docs/host-tools-readme

Conversation

@iarif4u

@iarif4u iarif4u commented Oct 2, 2026

Copy link
Copy Markdown

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.

Adds host-tools/README.md for setup.sh and testrunner.sh: setup order,
options, failure behavior and a cron example. The main README points to
it from Quick setup.

Fixes WordPress#261.
@github-actions

github-actions Bot commented Oct 2, 2026

Copy link
Copy Markdown

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

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

Co-authored-by: iarif4u <iarif4u@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

update readme to reflect addition of host-tools

1 participant