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
6 changes: 3 additions & 3 deletions .github/workflows/plugin-quality.yml
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ jobs:
"testsEnvironment": false,
"plugins": [ "https://downloads.wordpress.org/plugin/plugin-check.zip" ],
"mappings": {
"wp-content/plugins/waypoints": "$plugin_dir"
"wp-content/plugins/waypoints-trip-planner": "$plugin_dir"
}
}
EOF
Expand Down Expand Up @@ -154,10 +154,10 @@ jobs:
wp-env run cli wp plugin list-checks
wp-env run cli wp plugin list-check-categories

wp-env run cli wp plugin activate waypoints
wp-env run cli wp plugin activate waypoints-trip-planner

set +e
wp-env run cli wp plugin check waypoints \
wp-env run cli wp plugin check waypoints-trip-planner \
--format=json \
--ignore-warnings \
--exclude-files=.distignore,DECISIONS.md,phpcs.xml.dist,phpunit.xml.dist,.wp-env.json \
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/wp-submission-readiness.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,24 @@ on:
description: Public plugin display name expected for WordPress.org submission.
required: true
type: string
default: Waypoints
default: "Waypoints: Trip Planner"
expected_slug:
description: Permanent WordPress.org plugin slug and text domain expected for submission.
required: true
type: string
default: waypoints
default: waypoints-trip-planner
workflow_call:
inputs:
expected_name:
description: Public plugin display name expected for WordPress.org submission.
required: false
type: string
default: Waypoints
default: "Waypoints: Trip Planner"
expected_slug:
description: Permanent WordPress.org plugin slug and text domain expected for submission.
required: false
type: string
default: waypoints
default: waypoints-trip-planner

permissions:
contents: read
Expand Down
40 changes: 19 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Waypoints
# Waypoints: Trip Planner

Waypoints is a configurable WordPress plugin for building day-trip planners with
Google Maps and Places data. The plugin source lives in
Waypoints: Trip Planner is a configurable WordPress plugin for building
day-trip planners with Google Maps and Places data. The plugin source lives in
`plugin/waypoints/`.

## Status
Expand Down Expand Up @@ -75,22 +75,18 @@ and WordPress Plugin Check.

## Naming Note

The public plugin name is **Waypoints**. The source directory, text domain,
REST namespace, block name, and preferred shortcode now use `waypoints`. Some
legacy compatibility surfaces still use identifiers from the original name:
`[plan_your_day]` remains as a shortcode alias, `plan_your_day_*` remains for
settings/options/hooks, `Acodebeard\PlanYourDay` remains the PHP namespace, and
some asset/CSS identifiers remain unchanged to avoid unnecessary migration
risk.
The public plugin name is **Waypoints: Trip Planner**. The WordPress.org slug,
release artifact folder, and text domain use `waypoints-trip-planner`. The
source directory remains `plugin/waypoints/`, and compatibility identifiers
such as `[waypoints]`, `[plan_your_day]`, `plan_your_day_*`,
`Acodebeard\PlanYourDay`, REST namespace, block name, and asset/CSS handles
remain unchanged to avoid unnecessary migration risk.

## Credits

Special thanks to [Hagan](https://github.com/hagan) and
[Datapoke](https://github.com/datapoke) for development help.

Thanks also to [Destination Kona Coast](https://destinationkonacoast.org) for
the idea that started the project.

## Documentation

Start with [docs/README.md](docs/README.md). Current docs cover installation,
Expand All @@ -99,20 +95,21 @@ security, and troubleshooting.

## License

Waypoints is licensed under GPLv2 or later. See [LICENSE](LICENSE).
Waypoints: Trip Planner is licensed under GPLv2 or later. See
[LICENSE](LICENSE).

## Local Source Installation

1. Copy or symlink `plugin/waypoints/` into a WordPress installation at
`wp-content/plugins/waypoints/`.
`wp-content/plugins/waypoints-trip-planner/`.
2. From the plugin directory, install the Composer autoloader:

```sh
composer install
```

3. Activate **Waypoints** from the WordPress Plugins screen.
4. Open **Settings > Waypoints**.
3. Activate **Waypoints: Trip Planner** from the WordPress Plugins screen.
4. Open **Settings > Waypoints: Trip Planner**.
5. Configure the required default location and Google API keys.

Release zips should include generated Composer autoload files so production
Expand All @@ -126,9 +123,9 @@ From `plugin/waypoints/`, build an installable WordPress admin zip with:
./tools/build-release-zip.sh
```

The script creates `dist/waypoints-1.0.zip` at the repository root,
The script creates `dist/waypoints-trip-planner-1.0.2.zip` at the repository root,
installs production-only Composer autoload files into a temporary staging copy,
and packages the final artifact with a top-level `waypoints/` directory
and packages the final artifact with a top-level `waypoints-trip-planner/` directory
suitable for **Plugins > Add New > Upload Plugin**.

See [docs/RELEASES.md](docs/RELEASES.md) for the full manual GitHub release
Expand All @@ -142,8 +139,9 @@ candidate scan before submitting to WordPress.org. It is reusable through

The scan builds the release zip, runs the normal PHP checks, PHPStan, browser
smoke coverage, WordPress Plugin Check against the packaged artifact, and a
repo-local metadata check. The metadata check intentionally expects **Waypoints**
to use the permanent WordPress.org slug and text domain `waypoints`.
repo-local metadata check. The metadata check intentionally expects
**Waypoints: Trip Planner** to use the permanent WordPress.org slug and text
domain `waypoints-trip-planner`.

## Configuration

Expand Down
4 changes: 2 additions & 2 deletions docs/ADMIN.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Admin Workflows

Waypoints settings live under:
Waypoints: Trip Planner settings live under:

```text
Settings > Waypoints
Settings > Waypoints: Trip Planner
```

Only administrators with `manage_options` can change plugin settings or run the
Expand Down
4 changes: 2 additions & 2 deletions docs/ARCHITECTURE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Architecture

Waypoints is a generic WordPress plugin for building configurable day-trip
Waypoints: Trip Planner is a generic WordPress plugin for building configurable day-trip
planners with Google Maps and Places data.

## Plugin Entry Point
Expand Down Expand Up @@ -46,7 +46,7 @@ plan_your_day_settings
The admin page is registered under:

```text
Settings > Waypoints
Settings > Waypoints: Trip Planner
```

The admin screen currently exposes required default location fields, planner
Expand Down
14 changes: 7 additions & 7 deletions docs/INSTALLATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ plugin/waypoints/
For local development, copy or symlink that directory into a WordPress install:

```sh
ln -s /path/to/waypoints/plugin/waypoints /path/to/wordpress/wp-content/plugins/waypoints
ln -s /path/to/waypoints/plugin/waypoints /path/to/wordpress/wp-content/plugins/waypoints-trip-planner
```

Generate the Composer autoloader from the plugin directory:
Expand All @@ -32,19 +32,19 @@ composer install
Then activate the plugin from the WordPress admin Plugins screen or with WP-CLI:

```sh
wp --path=/path/to/wordpress plugin activate waypoints
wp --path=/path/to/wordpress plugin activate waypoints-trip-planner
```

In the WordPress admin, the plugin appears as **Waypoints**. Open
**Settings > Waypoints** after activation.
In the WordPress admin, the plugin appears as **Waypoints: Trip Planner**. Open
**Settings > Waypoints: Trip Planner** after activation.

## Local Test Install

One local development setup can look like this:

```text
/path/to/wordpress
/path/to/wordpress/wp-content/plugins/waypoints
/path/to/wordpress/wp-content/plugins/waypoints-trip-planner
-> /path/to/waypoints/plugin/waypoints
```

Expand All @@ -54,7 +54,7 @@ Useful local commands:
wp \
--path=/path/to/wordpress \
--url=https://example.test \
plugin status waypoints \
plugin status waypoints-trip-planner \
```

The admin settings screen is:
Expand Down Expand Up @@ -94,5 +94,5 @@ cd plugin/waypoints
./tools/build-release-zip.sh
```

The script writes `dist/waypoints-1.0.zip` at the repository root, which
The script writes `dist/waypoints-trip-planner-1.0.2.zip` at the repository root, which
can be uploaded through the WordPress Plugins screen.
2 changes: 1 addition & 1 deletion docs/QA.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Frontend QA

Waypoints keeps a lightweight browser smoke suite for the public planner
Waypoints: Trip Planner keeps a lightweight browser smoke suite for the public planner
frontend. The suite focuses on the shipped shortcode and block entry points, the
same-site REST flow, and a small set of accessibility-sensitive interactions.

Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Waypoints Documentation
# Waypoints: Trip Planner Documentation

This directory documents the WordPress plugin as it exists today. The plugin is
installable and has admin/settings, Google API, cache, planner helper, planner
Expand Down
15 changes: 8 additions & 7 deletions docs/RELEASES.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# Release Process

Waypoints v1 ships as a manual GitHub release zip. The plugin does not include a
private updater or a custom `Update URI` workflow right now.
Waypoints: Trip Planner v1 ships as a manual GitHub release zip. The plugin
does not include a private updater or a custom `Update URI` workflow right now.

## Release Metadata

Keep these values aligned before building a release:

- plugin header `Version` in the root PHP bootstrap file
- plugin header `Plugin Name` and `Text Domain`
- `PLAN_YOUR_DAY_VERSION`
- `PLAN_YOUR_DAY_TEXT_DOMAIN`
- `PLAN_YOUR_DAY_SCHEMA_VERSION`
- `plugin/waypoints/release.json`
- the artifact filename in `release.json`
Expand All @@ -18,7 +20,7 @@ The release builder validates that:

- `release.json.version` matches `PLAN_YOUR_DAY_VERSION`
- `release.json.schemaVersion` matches `PLAN_YOUR_DAY_SCHEMA_VERSION`
- the artifact filename matches the plugin slug and version
- the artifact filename and top-level zip folder match the plugin slug and version

## Standard Release Steps

Expand Down Expand Up @@ -46,17 +48,16 @@ The release builder validates that:

The current release artifact is an installable WordPress admin zip with:

- a top-level `waypoints/` directory
- a top-level `waypoints-trip-planner/` directory
- production Composer autoload files included
- development-only files excluded through `.distignore`

Production sites should install the built zip and should not need to run
Composer on the server.

Current v1.0 artifact:
Current v1.0.2 artifact:

- filename: `waypoints-1.0.zip`
- SHA-256: `acc93ed02e41585f4f9e2799d739d38fc374bf4e416852bdf0f16394d7af6e6c`
- filename: `waypoints-trip-planner-1.0.2.zip`

## Update Expectations

Expand Down
2 changes: 1 addition & 1 deletion docs/SETTINGS.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Settings Reference

Waypoints stores plugin configuration in:
Waypoints: Trip Planner stores plugin configuration in:

```text
plan_your_day_settings
Expand Down
10 changes: 5 additions & 5 deletions docs/USAGE.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Frontend Usage

Waypoints can be rendered through either the block editor or the shortcode. Both
entry points use the same server-rendered planner and the same frontend CSS and
JavaScript assets.
Waypoints: Trip Planner can be rendered through either the block editor or the
shortcode. Both entry points use the same server-rendered planner and the same
frontend CSS and JavaScript assets.

## Before You Place The Planner

Make sure the plugin has been configured under:

```text
Settings > Waypoints
Settings > Waypoints: Trip Planner
```

At minimum, set:
Expand All @@ -26,7 +26,7 @@ instead of the full planner.
The plugin registers a dynamic block named:

```text
Waypoints
Waypoints: Trip Planner
```

Editor behavior:
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "waypoints-qa",
"private": true,
"description": "Browser smoke tests for the Waypoints plugin repository.",
"description": "Browser smoke tests for the Waypoints: Trip Planner plugin repository.",
"scripts": {
"browser-smoke": "playwright test"
},
Expand Down
Loading