From 4d4f296fcca4bcc739699de256e7a67c23291690 Mon Sep 17 00:00:00 2001 From: MobileMage Date: Wed, 28 Oct 2026 15:27:49 +0100 Subject: [PATCH] docs: link the release of the WooCommerce plugin The plugin guide said that the plugin had no release and no zip. The v0.1.0 release on GitHub now holds the zip, so the guide links it. It also says that WordPress.org reviews the plugin now. The build steps stay as a second way to get the zip. The release flag of the plugin is now "published". The test that tied the guide to the old README now checks that both link the release. Signed-off-by: MobileMage --- src/content/docs/guides/woocommerce.md | 12 +++++++----- src/release-state.json | 2 +- test/unit/woocommerce-page.test.ts | 10 ++++++++-- woocommerce | 2 +- 4 files changed, 17 insertions(+), 9 deletions(-) diff --git a/src/content/docs/guides/woocommerce.md b/src/content/docs/guides/woocommerce.md index 965e07d..c0e2f42 100644 --- a/src/content/docs/guides/woocommerce.md +++ b/src/content/docs/guides/woocommerce.md @@ -12,9 +12,13 @@ The field shows only when the address is in Nigeria. It works in the classic che ## Install -The plugin is not published yet. It has no release, and it is not on WordPress.org. There is no zip file to download today. +The first release is [v0.1.0 on GitHub](https://github.com/gatepost-dev/woocommerce/releases/tag/v0.1.0). WordPress.org reviews the plugin now, so the plugin directory does not list it yet. -To try the plugin now, build the zip file from the source. You need Git, PHP 8.1 or later and Composer. +Download `gatepost-postcode-for-woocommerce.zip` from the release. Do not use the source archive that GitHub offers. It does not hold the bundled SDK, so the plugin cannot start. + +Install and activate WooCommerce first. Then, in WordPress, go to Plugins > Add New Plugin > Upload Plugin, upload the zip file, and activate it. + +To build the zip file yourself, you need Git, PHP 8.1 or later and Composer. ```sh notrun git clone https://github.com/gatepost-dev/woocommerce @@ -23,9 +27,7 @@ composer install scripts/build-zip ``` -The script writes `dist/gatepost-postcode-for-woocommerce.zip`. Do not use the source archive that GitHub offers. It does not hold the bundled SDK, so the plugin cannot start. - -Install and activate WooCommerce first. Then, in WordPress, go to Plugins > Add New Plugin > Upload Plugin, upload the zip file, and activate it. +The script writes `dist/gatepost-postcode-for-woocommerce.zip`. ## Choose the settings diff --git a/src/release-state.json b/src/release-state.json index 5795c90..3e538de 100644 --- a/src/release-state.json +++ b/src/release-state.json @@ -1,4 +1,4 @@ { "state": "published", - "plugin": "not published" + "plugin": "published" } diff --git a/test/unit/woocommerce-page.test.ts b/test/unit/woocommerce-page.test.ts index 29d4dcf..543fc44 100644 --- a/test/unit/woocommerce-page.test.ts +++ b/test/unit/woocommerce-page.test.ts @@ -97,9 +97,15 @@ describe('the WooCommerce page', () => { expect(PAGE).toContain('`nipost_live_`'); }); - it('says that the plugin has no release, in step with the readme of the plugin', () => { - expect(README_MD).toContain('The plugin has no release yet'); + it('links the release that the readme of the plugin links', () => { + const release = 'https://github.com/gatepost-dev/woocommerce/releases/tag/v0.1.0'; + expect(README_MD).toContain(release); + expect(PAGE).toContain(release); + }); + + it('says that WordPress.org does not list the plugin yet, in step with the readme', () => { expect(README_TXT).toContain('This plugin is not on WordPress.org yet.'); + expect(PAGE).toContain('the plugin directory does not list it yet'); }); // The page holds the claims of an unpublished plugin until the release flag changes. diff --git a/woocommerce b/woocommerce index e634dd4..df88715 160000 --- a/woocommerce +++ b/woocommerce @@ -1 +1 @@ -Subproject commit e634dd451fd726241f6cb767233ff85c13e5b682 +Subproject commit df88715ce4a8100394b24cc4b7dff5a9a0a4f3b1