WP Manifestindependent plugin directory
manifest / security / staging-safety

Staging Safety

WordPress plugin: shows which copy of a site you're on, holds emails on staging and local copies, and keeps them out of search engines.

by AJM Media · github.com/ajm-media/staging-safety · website

★ 0stars
0forks

Install

No release zip yet. The repository archive installs, but the folder name will carry the branch suffix and updates will not flow:

wp plugin install https://github.com/ajm-media/staging-safety/archive/refs/heads/main.zip
Readme github.com/ajm-media/staging-safety ↗

WordPress plugin that shows which copy of a site you're on, holds emails on staging and local copies, and keeps those copies out of search engines.

  • Admin bar badge: Local, Development, Staging or Production, each in its own colour.
  • On copies: emails held and logged (or rerouted to one address), noindex on every page, core sitemaps off.
  • On the live site: a warning if "Discourage search engines" is switched on.
  • The live site is identified by its saved address (or WP_ENVIRONMENT_TYPE), so a copied database knows it's a copy. Until that's set, only clearly local addresses are guarded.

The wp.org listing text is in readme.txt.

Development

The repo root is the plugin folder. Build the release zip from the committed code; files marked export-ignore in .gitattributes are left out:

git archive --format=zip --prefix=staging-safety/ -o ../staging-safety.zip HEAD

wp.org listing images (icon, banner, screenshots) are in .wordpress-org/. The icon and banner are rendered from the HTML in listing-images/:

PLAYWRIGHT=/path/to/node_modules/playwright node listing-images/render.mjs

Tests run in GitHub Actions on every branch push (tests/run.sh): WordPress in Docker, moved between a live address, a copy address, a staging-looking address and a local one, across PHP 7.4-8.3, WordPress 6.0 and latest, single site and multisite.

Releasing

  1. Bump the version in the plugin header, STSF_VERSION and the readme's Stable tag, and add a changelog entry.
  2. Push the commit, then push a tag with the bare version number, e.g. git tag 1.0.0 && git push origin 1.0.0.

The tag runs the tests, checks the three version numbers match, then publishes to WordPress.org SVN (trunk, tags/<version> and the listing images). It needs the SVN_USERNAME and SVN_PASSWORD repository secrets.

wp-config constants: STAGING_SAFETY_PRODUCTION_URL, STAGING_SAFETY_DISABLE. Filters: staging_safety_environment, staging_safety_local_suffixes, staging_safety_staging_suffixes.

Support

Found a bug or have an idea? Open an issue.

The plugin is free. If it saves you time, you can buy me a coffee.

Licence

GPLv2 or later.