Skip to content

Commit 96684d8

Browse files
authored
Merge pull request #20 from basicrum/wp-marketplace-address-feedback
Wp marketplace address feedback
2 parents 0317ac1 + c33f6da commit 96684d8

35 files changed

Lines changed: 674 additions & 471 deletions

‎.github/workflows/ci.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -242,13 +242,13 @@ jobs:
242242
run: sh tools/build-release.sh
243243

244244
- name: Install and test packaged plugin
245-
run: sh tools/smoke-test-release.sh release/basicrum.zip
245+
run: sh tools/smoke-test-release.sh release/basicrum-real-user-monitoring.zip
246246

247247
- name: Upload release artifact
248248
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
249249
with:
250250
name: basicrum-release
251251
path: |
252-
release/basicrum.zip
253-
release/basicrum.zip.sha256
252+
release/basicrum-real-user-monitoring.zip
253+
release/basicrum-real-user-monitoring.zip.sha256
254254
if-no-files-found: error

‎.github/workflows/prerelease.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,11 @@ jobs:
4242
run: sh tools/build-release.sh
4343

4444
- name: Install and test packaged plugin
45-
run: sh tools/smoke-test-release.sh release/basicrum.zip
45+
run: sh tools/smoke-test-release.sh release/basicrum-real-user-monitoring.zip
4646

4747
- name: Upload release assets
4848
uses: softprops/action-gh-release@3d0d9888cb7fd7b750713d6e236d1fcb99157228 # v3.0.2
4949
with:
5050
files: |
51-
release/basicrum.zip
52-
release/basicrum.zip.sha256
51+
release/basicrum-real-user-monitoring.zip
52+
release/basicrum-real-user-monitoring.zip.sha256

‎.github/workflows/release.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ jobs:
4545
run: sh tools/build-release.sh
4646

4747
- name: Install and test packaged plugin
48-
run: sh tools/smoke-test-release.sh release/basicrum.zip
48+
run: sh tools/smoke-test-release.sh release/basicrum-real-user-monitoring.zip
4949

5050
- name: Create GitHub release and upload assets
5151
uses: softprops/action-gh-release@3d0d9888cb7fd7b750713d6e236d1fcb99157228 # v3.0.2
@@ -54,5 +54,5 @@ jobs:
5454
generate_release_notes: true
5555
fail_on_unmatched_files: true
5656
files: |
57-
release/basicrum.zip
58-
release/basicrum.zip.sha256
57+
release/basicrum-real-user-monitoring.zip
58+
release/basicrum-real-user-monitoring.zip.sha256

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ coverage.xml
2727

2828
# Release artifacts
2929
/release/
30-
/basicrum.zip
30+
/basicrum-real-user-monitoring.zip
3131

3232
# Local research and planning notes
3333
/plan-refs/

‎AGENTS.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,8 @@ in the matching skill.
5050

5151
## Conventions
5252

53-
- Follow WordPress-Core/WPCS. The text domain is `basicrum`.
53+
- Follow WordPress-Core/WPCS. The WordPress.org slug and text domain are
54+
`basicrum-real-user-monitoring`.
5455
- Guard PHP files with `ABSPATH`; escape output and sanitize all input.
5556
- Use ASCII hyphens (`-`); do not use typographic dashes in source, comments,
5657
documentation, or user-facing text.

‎CONTRIBUTING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The development site is available at <http://localhost:9080/> with `admin` / `ba
2424

2525
The installable plugin is [`plugins/basicrum/`](plugins/basicrum/). Repository root files provide development, browser-test, Docker, CI, and release tooling.
2626

27-
Follow the permanent conventions in [AGENTS.md](AGENTS.md), including WordPress Coding Standards, PHP 7.4 compatibility, ASCII hyphens, synchronized version metadata, privacy-safe consent behavior, and immutable GitHub Actions pins.
27+
Follow the permanent conventions in [AGENTS.md](AGENTS.md), including WordPress Coding Standards, PHP 7.4 compatibility, ASCII hyphens, the assigned WordPress.org text domain, synchronized version metadata, privacy-safe consent behavior, and immutable GitHub Actions pins.
2828

2929
When changing user-facing text, regenerate the WordPress POT template. Locale-specific PO and MO files are not bundled. When changing settings, keep defaults, rendering, validation, runtime behavior, tests, and documentation synchronized.
3030

‎Makefile‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ WP_SERVICE = wordpress
44
DB_SERVICE = db
55
WPCLI_SERVICE = wpcli
66
JS_SERVICE = javascript
7-
WPCLI_PLUGIN_WORKDIR = /var/www/html/wp-content/plugins/basicrum
7+
PLUGIN_SLUG = basicrum-real-user-monitoring
8+
RELEASE_ARCHIVE = release/$(PLUGIN_SLUG).zip
9+
WPCLI_PLUGIN_WORKDIR = /var/www/html/wp-content/plugins/$(PLUGIN_SLUG)
810
PLUGIN_DIR = plugins/basicrum
911
PLUGIN_WORKDIR = /workspace
1012
TEST_DB_NAME = wordpress_test
@@ -92,6 +94,7 @@ composer-audit:
9294
conventions:
9395
sh tools/verify-ascii-hyphens.sh
9496
sh tools/verify-version-consistency.sh
97+
sh tools/verify-text-domain.sh
9598
sh tools/verify-boomerang-provenance.sh
9699

97100
translations:
@@ -128,10 +131,10 @@ package:
128131
$(COMPOSE) run --rm --no-deps -w /repo $(PHP_SERVICE) sh /tools/build-release.sh /repo/$(PLUGIN_DIR) /repo/release
129132

130133
package-verify:
131-
$(COMPOSE) run --rm --no-deps -w /repo $(PHP_SERVICE) sh /tools/verify-release.sh /repo/release/basicrum.zip
134+
$(COMPOSE) run --rm --no-deps -w /repo $(PHP_SERVICE) sh /tools/verify-release.sh /repo/$(RELEASE_ARCHIVE)
132135

133136
package-smoke: package
134-
sh tools/smoke-test-release.sh release/basicrum.zip
137+
sh tools/smoke-test-release.sh $(RELEASE_ARCHIVE)
135138

136139
clean:
137140
$(COMPOSE) down -v

‎README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Basicrum is a privacy-first Real User Monitoring integration for WordPress. It loads the bundled Boomerang library, tags WordPress and WooCommerce page types, and sends performance beacons to a configured hosted or self-hosted Basicrum collector.
44

5-
The installable plugin lives in [`plugins/basicrum/`](plugins/basicrum/). Build release artifacts through the repository tooling instead of zipping the source directory directly.
5+
The plugin source lives in [`plugins/basicrum/`](plugins/basicrum/). Release tooling packages it under the assigned WordPress.org directory slug `basicrum-real-user-monitoring`; do not zip the source directory directly.
66

77
## Privacy
88

@@ -18,7 +18,7 @@ The complete webmaster-facing behavior and consent instructions live in the [Wor
1818

1919
| Path | Purpose |
2020
| --- | --- |
21-
| [`plugins/basicrum/`](plugins/basicrum/) | Installable plugin source |
21+
| [`plugins/basicrum/`](plugins/basicrum/) | Plugin source packaged under the WordPress.org slug |
2222
| [`tools/`](tools/) | Setup, test, and release scripts |
2323
| [`docker/`](docker/) | Local WordPress and WooCommerce environments |
2424
| [`tests/javascript/`](tests/javascript/) | Browser tests for loaders, consent adapters, and settings |
@@ -53,7 +53,7 @@ See [AGENTS.md](AGENTS.md) for repository invariants, the complete check suite,
5353

5454
## Releases
5555

56-
`make package` creates `release/basicrum.zip` and its SHA-256 checksum from a temporary production Composer install. `make package-smoke` installs that ZIP into clean WordPress and checks activation, the administration page, frontend loading, and PHP logs.
56+
`make package` creates `release/basicrum-real-user-monitoring.zip` and its SHA-256 checksum from a temporary production Composer install. `make package-smoke` installs that ZIP into clean WordPress and checks activation, the administration page, frontend loading, and PHP logs.
5757

5858
The plugin header version, `BASICRUM_VERSION`, WordPress `Stable tag`, top changelog version, and `v<version>` release tag must match.
5959

@@ -64,7 +64,7 @@ git tag -a vX.Y.Z -m "Basicrum vX.Y.Z"
6464
git push origin vX.Y.Z
6565
```
6666

67-
The tag workflow verifies the version, runs the release tests, builds and smoke-tests the installable ZIP, and only then creates the GitHub Release with `basicrum.zip` and `basicrum.zip.sha256`. Do not create the GitHub Release or upload the ZIP manually.
67+
The tag workflow verifies the version, runs the release tests, builds and smoke-tests the installable ZIP, and only then creates the GitHub Release with `basicrum-real-user-monitoring.zip` and `basicrum-real-user-monitoring.zip.sha256`. Do not create the GitHub Release or upload the ZIP manually.
6868

6969
## Contributing and security
7070

‎checklist.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ Acceptance criteria:
148148
- [ ] Record the minifier and its version in a lock file.
149149
- [ ] Make CI regenerate the loaders and fail when the committed output differs.
150150
- [ ] Document the source and version of the bundled Boomerang asset.
151-
- [x] Add a repeatable command for generating `languages/basicrum.pot`.
151+
- [x] Add a repeatable command for generating `languages/basicrum-real-user-monitoring.pot`.
152152
- [x] Keep locale-specific PO and MO files out of the repository and release ZIP.
153153
- [x] Keep POT generation as a local maintenance command; the standalone
154154
translation CI job was removed by product decision.
@@ -164,7 +164,10 @@ Acceptance criteria:
164164
tracked source, comments, documentation, and user-facing text.
165165
- [x] Add a version consistency check covering the plugin header,
166166
`BASICRUM_VERSION`, `Stable tag`, changelog, and release tag.
167-
- [x] Run both checks in pull requests and pushes to the main branch.
167+
- [x] Add a WordPress.org slug and text-domain consistency check covering the
168+
plugin header, source literals, WPCS configuration, POT filename, and release
169+
package identity.
170+
- [x] Run all convention checks in pull requests and pushes to the main branch.
168171
- [x] Document the checks in `AGENTS.md` and the contributor documentation.
169172

170173
Acceptance criteria:

‎docker-compose.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ services:
3333
- "${WORDPRESS_PORT:-9080}:80"
3434
volumes:
3535
- wordpress_data:/var/www/html
36-
- ./plugins/basicrum:/var/www/html/wp-content/plugins/basicrum
36+
- ./plugins/basicrum:/var/www/html/wp-content/plugins/basicrum-real-user-monitoring
3737

3838
wpcli:
3939
image: wordpress:cli-2.12.0-php8.2
@@ -53,7 +53,7 @@ services:
5353
WP_ADMIN_EMAIL: ${WP_ADMIN_EMAIL:-admin@example.test}
5454
volumes:
5555
- wordpress_data:/var/www/html
56-
- ./plugins/basicrum:/var/www/html/wp-content/plugins/basicrum
56+
- ./plugins/basicrum:/var/www/html/wp-content/plugins/basicrum-real-user-monitoring
5757
- ./tools:/tools:ro
5858

5959
php:

0 commit comments

Comments
 (0)