Skip to content

Commit 935f9d9

Browse files
MickLeskMickLesk
committed
Use notes and install_methods fields
Update PocketBase bot and import workflow to use direct `notes` and `install_methods` fields instead of the older `notes_json`/`install_methods_json` relations. Adjust parsing, PATCH/POST payloads and error messages accordingly, remove project_url handling, and drop the separate resolution/creation of related note/install_method records in the import script. Also update docs to reflect the new field names and clean up some formatting and allowed-field lists.
1 parent 41bae87 commit 935f9d9

3 files changed

Lines changed: 32 additions & 123 deletions

File tree

‎.github/workflows/pocketbase-bot.yml‎

Lines changed: 13 additions & 15 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.github/workflows/push_json_to_pocketbase.yml‎

Lines changed: 3 additions & 104 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/pocketbase-bot.md‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,20 @@
66
---
77

88
### 🔧 Field Updates
9+
910
Simple key=value pairs. Multiple in one line.
11+
1012
```
1113
/pocketbase <slug> field=value [field=value ...]
1214
```
15+
1316
**Boolean fields** (`true`/`false`): `updateable` `privileged` `has_arm` `is_dev` `is_disabled` `is_deleted`
14-
**Text fields**: `name` `description` `logo` `documentation` `website` `project_url` `github` `config_path` `disable_message` `deleted_message`
17+
**Text fields**: `name` `description` `logo` `documentation` `website` `github` `config_path` `disable_message` `deleted_message`
1518
**Number**: `port`
16-
**Nullable**: `default_user` `default_passwd` *(empty value = null: `default_passwd=`)*
19+
**Nullable**: `default_user` `default_passwd` _(empty value = null: `default_passwd=`)_
1720

1821
**Examples:**
22+
1923
```
2024
/pocketbase homeassistant is_disabled=true disable_message="Broken upstream"
2125
/pocketbase homeassistant documentation=https://www.home-assistant.io/docs
@@ -26,40 +30,48 @@ Simple key=value pairs. Multiple in one line.
2630
---
2731

2832
### 📝 set — HTML / Multiline / Special Characters
33+
2934
Use a code block for values that contain HTML, links, quotes or newlines.
35+
3036
````
3137
/pocketbase <slug> set <field>
3238
```
3339
Your content here — HTML tags, links, quotes, all fine
3440
```
3541
````
36-
**Allowed fields:** `name` `description` `logo` `documentation` `website` `project_url` `github` `config_path` `disable_message` `deleted_message`
42+
43+
**Allowed fields:** `name` `description` `logo` `documentation` `website` `github` `config_path` `disable_message` `deleted_message`
3744

3845
---
3946

4047
### 🗒️ Notes
48+
4149
```
4250
/pocketbase <slug> note list
4351
/pocketbase <slug> note add <type> "<text>"
4452
/pocketbase <slug> note edit <type> "<old text>" "<new text>"
4553
/pocketbase <slug> note remove <type> "<text>"
4654
```
47-
Note types come from `z_ref_note_types` in PocketBase (e.g. `info`, `warning`).
55+
56+
Note types: `info`, `warning`.
4857
If text doesn't match exactly, the bot lists all current notes automatically.
4958

5059
---
5160

5261
### ⚙️ Install Method Resources
62+
5363
```
5464
/pocketbase <slug> method list
5565
/pocketbase <slug> method <type> hdd=10
5666
/pocketbase <slug> method <type> cpu=4 ram=2048 hdd=20
5767
```
68+
5869
`<type>` matches the install method type name (e.g. `default`, `alpine`). Use `method list` to see available types and current values. `ram` = MB, `hdd` = GB.
5970

6071
---
6172

6273
### 💡 Tips
74+
6375
- The bot reacts with 👀 when it picks up the command, ✅ on success, 👎 on error
6476
- On any error, a comment explains what went wrong
6577
- `note edit` / `note remove` show the current note list if the text doesn't match

0 commit comments

Comments
 (0)