Skip to content

Commit e2d6d56

Browse files
committed
Update docs to reflect current feature set and add release guide
- Fix readme description to list actual features instead of outdated "number of posts to display" reference - Remove "Exclude posts by category" — the ExcludeTaxonomies trait/component is not wired up - Add Comment Count and Included Posts to sort options in both readmes - Remove outdated note about sorting being a duplication of core controls - Update readme.txt screenshots section to remove stale post count/offset reference - Add RELEASE.md documenting the full release process
1 parent 16214ba commit e2d6d56

File tree

3 files changed

+69
-11
lines changed

3 files changed

+69
-11
lines changed

RELEASE.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Release Process
2+
3+
## 1. Bump the version number
4+
5+
Update the version string in **three places**:
6+
7+
- `index.php``Version: X.X.X`
8+
- `package.json``"version": "X.X.X"`
9+
- `readme.txt``Stable tag: X.X.X`
10+
11+
## 2. Update the changelog
12+
13+
Add a new entry at the top of the `== Changelog ==` section in `readme.txt`:
14+
15+
```
16+
= X.X.X =
17+
* Description of change.
18+
```
19+
20+
## 3. Run linting
21+
22+
```bash
23+
npm run format
24+
npm run lint:php
25+
```
26+
27+
Fix any issues before proceeding.
28+
29+
## 4. Commit and push to `trunk`
30+
31+
```bash
32+
git add .
33+
git commit -m "Release X.X.X"
34+
git push origin trunk
35+
```
36+
37+
Pushing to `trunk` triggers the Release Drafter GitHub Action, which auto-drafts release notes from merged PR labels (`enhancement`, `bug`, `fix`).
38+
39+
## 5. Build the release artifact
40+
41+
```bash
42+
npm run release
43+
```
44+
45+
This runs three steps in sequence:
46+
47+
1. `composer run build` — strips dev PHP dependencies and optimizes the autoloader
48+
2. `npm run build` — compiles production JS/TS
49+
3. `npm run plugin-zip` — creates the distributable ZIP
50+
51+
The ZIP includes only the files listed in the `files` field of `package.json`: `build/`, `index.php`, `readme.txt`, `includes/`, `vendor/autoload.php`, and `vendor/composer`.
52+
53+
## 6. Publish the GitHub Release
54+
55+
1. Go to GitHub → Releases and find the draft created by Release Drafter
56+
2. Set the tag to `X.X.X` (matching `readme.txt`'s `Stable tag`)
57+
3. Attach the generated ZIP as a release asset
58+
4. Publish
59+
60+
## 7. Deploy to WordPress.org
61+
62+
Upload the ZIP (or use SVN) to the WordPress.org plugin repository, updating the `trunk` and `tags/X.X.X` directories.

readme.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## Description
88

9-
This plugin introduces a Query Loop block variation that will empower users to be able to do much more complicated queries with the Query Loop block, such number of posts to display and post meta
9+
This plugin introduces a Query Loop block variation that will empower users to be able to do much more complicated queries with the Query Loop block, such as taxonomy queries, post meta queries, date queries, post ordering, and more
1010

1111
### Support/Issues
1212

@@ -30,10 +30,6 @@ Choose the posts you want to display manually or only the children of the curren
3030

3131
Remove the current post from the query.
3232

33-
#### Exclude posts by category
34-
35-
Choose to exclude posts from a list of categories.
36-
3733
#### Exclude posts list
3834

3935
Curate a list of posts to exclude from the query.
@@ -51,17 +47,17 @@ Query items before/after the current or selected or choose to show the post from
5147
Sort in ascending or descending order by:
5248

5349
- Author
50+
- Comment Count
5451
- Date
52+
- Included Posts
5553
- Last Modified Date
56-
- Title
54+
- Menu Order (props to @jvanja)
5755
- Meta Value
5856
- Meta Value Num
59-
- Random
60-
- Menu Order (props to @jvanja)
6157
- Name (props @philbee)
6258
- Post ID (props to @markhowellsmead)
63-
64-
**Please note that this is a slight duplication of the existing sorting controls. They both work interchangeably but it just looks a bit odd in the UI**
59+
- Random
60+
- Title
6561

6662
#### Disable Pagination
6763

readme.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@ Take full control over which posts appear in your query:
5252
Keep your queries clean and relevant:
5353
* **Exclude current post**: Automatically hide the post being viewed
5454
* **Exclude a list of posts**: Curate a list of posts to exclude from the query
55-
* **Category filtering**: Exclude posts from specific categories
5655

5756
==== 🔍 Advanced Post Meta Queries ====
5857

@@ -83,6 +82,7 @@ Sort your content exactly how you want:
8382
* **Name**: Sort by post slug
8483
* **Post ID**: Sort by post ID
8584
* **Comment Count**: Sort by engagement
85+
* **Included Posts**: Sort by post inclusion order
8686

8787
==== ⚡ Performance Optimization ====
8888

0 commit comments

Comments
 (0)