Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## Unreleased

No changes yet.

## 0.2.0 — 2026-09-30

- Rename the standalone executable to `bin/runtime`, installed by Composer as `vendor/bin/runtime`; update existing shell and CI scripts when upgrading.
- Prevent environment secrets from reaching temporary-directory fallbacks; support private group-readable artifacts.
- Add native source-aware environment cache invalidation, mounted secret files, typed requirements and names-only environment comparison.
Expand Down
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,9 @@ PHP **8.5 or newer**, Composer **2.10.3 or newer** with plugin API **2.6 or newe
and a Composer-managed WordPress installation. Composer resolves Runtime's Symfony
8.1 dependencies. WordPress and your application may require additional PHP extensions.

Install the tagged release `0.1.0` and commit the resolved lockfile. The repository
Install the tagged release `0.2.0` and commit the resolved lockfile. The repository
is private, so use an authorized GitHub account or a repository-scoped read credential.
Version 0.1.0 is the initial release accepted for the documented SymPress layouts;
review release notes before changing the pinned version.
Review the [upgrade notes](docs/releases/0.2.0.md) before updating an existing site.

## Start here

Expand All @@ -41,9 +40,8 @@ For an existing site, start with [Adopting Runtime](docs/migration.md).

Once Runtime is installed, run these commands from your project root:

The examples use the upcoming executable name `runtime`. With the tagged 0.1.0
release, use `sympress-runtime` as the executable name instead; see the
[CLI upgrade note](docs/cli.md).
Version 0.2.0 uses the executable name `runtime`. When upgrading from 0.1.0,
update shell and CI scripts to use this name; see [Command line](docs/cli.md).

```sh
vendor/bin/runtime validate
Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Do not include production credentials in the report.

## Supported revisions

The initial supported release is `0.1.0`. Fixes are developed on `main` and shipped
The current supported release is `0.2.0`. Fixes are developed on `main` and shipped
as tagged releases. Pin a reviewed release and its lockfile; update deliberately
when a relevant fix is available. The Composer library is restricted to `~2.10.3`;
new minor lines require recovery-matrix validation before widening that constraint.
Expand Down
6 changes: 3 additions & 3 deletions docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

Run these commands from the directory containing your project's `composer.json`.

The development branch provides `bin/runtime`, installed by Composer as
`vendor/bin/runtime`. This rename is unreleased; version 0.1.0 uses the executable
name `sympress-runtime`. Update shell and CI scripts when upgrading.
Version 0.2.0 provides `bin/runtime`, installed by Composer as `vendor/bin/runtime`.
Version 0.1.0 used the executable name `sympress-runtime`. Update shell and CI
scripts when upgrading; see the [0.2.0 upgrade notes](releases/0.2.0.md).

```sh
# Inspect configuration without running project providers.
Expand Down
4 changes: 2 additions & 2 deletions docs/configuration.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Configuration

This page describes the current development branch. The production operations
options listed in [Unreleased](../CHANGELOG.md#unreleased) are not part of 0.1.0.
This page describes Runtime 0.2.0. See the [upgrade notes](releases/0.2.0.md)
for new options and changed native defaults when moving from 0.1.0.

Runtime settings describe setup behavior. WordPress environment values such as
database credentials and public URLs belong in [environment configuration](environment.md).
Expand Down
7 changes: 3 additions & 4 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@ You need PHP 8.5+, Composer 2.10.3+, a database and a web server. Runtime's priv
repository also requires GitHub read access. Keep credentials in Composer's private
authentication configuration or an SSH agent, never in `composer.json`.

Commands below use the upcoming executable name `runtime`. The example manifest
pins 0.1.0, whose executable is named `sympress-runtime`; substitute that name
until you upgrade to a release containing the rename. See [Command line](cli.md).
Commands below use `runtime`, the executable provided by the pinned 0.2.0 release.
Existing 0.1.0 projects should follow the [upgrade notes](releases/0.2.0.md).

## 1. Describe the project

Expand All @@ -24,7 +23,7 @@ cd my-site
composer install
```

The example pins Runtime `0.1.0`. Commit `composer.lock` and deploy with `composer install`, not an unreviewed update.
The example pins Runtime `0.2.0`. Commit `composer.lock` and deploy with `composer install`, not an unreviewed update.

The resulting layout is:

Expand Down
2 changes: 1 addition & 1 deletion docs/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ web-server routes. Adding Runtime does not require a URL change.
Install the package without running setup while preparing the configuration:

```sh
composer require sympress/runtime:0.1.0 --no-plugins --no-scripts
composer require sympress/runtime:0.2.0 --no-plugins --no-scripts
```

The private repository must already be present in Composer's repository
Expand Down
4 changes: 2 additions & 2 deletions docs/operations.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Deployment checks and maintenance

These commands and options are unreleased. They will be available in the next
Runtime release; installing 0.1.0 does not include them.
These commands and options require Runtime 0.2.0 or newer. Existing 0.1.0 projects
should first follow the [upgrade notes](releases/0.2.0.md).

Build once with the regular Composer installers, verify the generated artifacts,
then deploy the lockfiles, generated configuration and referenced runtime payload.
Expand Down
57 changes: 57 additions & 0 deletions docs/releases/0.2.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Upgrading to Runtime 0.2.0

Version 0.2.0 adds production diagnostics, deployment drift checks, download pins
and crash recovery. PHP 8.5+, Composer 2.10.3+ and the reviewed Composer library
line remain required. Read the [changelog](../../CHANGELOG.md) for the full list.

## Update the package and command paths

Change shell scripts and CI jobs from `vendor/bin/sympress-runtime` to
`vendor/bin/runtime`. The old executable is no longer shipped. Composer commands
such as `composer sympress-runtime` and configuration keys keep their names.

Update in your development or build environment, review the resulting lockfile
and generated files, then deploy that reviewed build:

```sh
composer require sympress/runtime:0.2.0 --no-plugins --no-scripts
composer install --no-interaction
vendor/bin/runtime validate
vendor/bin/runtime --no-interaction
```

If deployment uses a prebuilt environment dump, rebuild it for the intended
environment before deployment. Do not distribute a development dump to production.
Keep the referenced `var/runtime` payload with the generated configuration as
described in [Deployment](../deployment.md).

## Review native defaults

- Environment caching defaults to `auto` and invalidates on source path, size or
modification-time changes. Production dumps remain immutable until rebuilt.
- `composer-managed: auto` disables dashboard file modifications and automatic
updates in staging/production through the generated section. Existing constants
take precedence; explicitly configure `false` if updates are managed elsewhere.
- Native URL downloads create `sympress-runtime.lock`. Review and commit it, and
use `--update-lock` deliberately when changing downloaded artifacts.
- Native `db-check: health` no longer scans every table during setup. Schedule
`vendor/bin/runtime doctor --database-health` explicitly; `--quick` is available.
- Doctor requires explicit `WP_HOME` in staging/production. Its production profile
requires HTTPS and reports opaque bootstrap code or unproven permissions as
unknown, rather than certifying them.

Compatibility profiles retain their documented defaults. The generated-file mode
still defaults to `0600`; use `generated-file-mode: "0640"` with appropriate group
ownership when deployment and PHP run as different users.

## Establish deployment checks

Run setup successfully before using `--check` or `--dry-run`: drift detection needs
the generated baseline. Custom setup side effects can produce an unknown result.
Use [production operations](../operations.md) for deployment gates, typed required
variables, mounted secrets, names-only environment comparison and pruning.

Interrupted supported package moves now recover through a private journal.
Keep pending journals and owned backups intact until recovery completes. Pruning
retains active payloads and refuses unknown ownership or pending recovery state.
The supported layout boundaries remain documented in [Deployment](../deployment.md).
2 changes: 1 addition & 1 deletion examples/site/composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"type": "project",
"require": {
"php": "^8.5",
"sympress/runtime": "0.1.0",
"sympress/runtime": "0.2.0",
"johnpbloch/wordpress-core": "^7.1",
"johnpbloch/wordpress-core-installer": "^2.0",
"composer/installers": "^2.3"
Expand Down
2 changes: 1 addition & 1 deletion src/Console/Application.php
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public static function main(array $arguments, string $root, string $vendor, ?arr
}
break;
}
$application = new ConsoleApplication('SymPress Runtime', '0.1.0-dev');
$application = new ConsoleApplication('SymPress Runtime', '0.2.0');
$application->setAutoExit(false);
$application->addCommand(new RuntimeCommand($context, $operation));
$application->setDefaultCommand($operation, true);
Expand Down
Loading