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
12 changes: 7 additions & 5 deletions src/content/docs/guides/woocommerce.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/release-state.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"state": "published",
"plugin": "not published"
"plugin": "published"
}
10 changes: 8 additions & 2 deletions test/unit/woocommerce-page.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion woocommerce