Skip to content

Commit 71e71ce

Browse files
committed
docs: document published AUR package and keep packaging/aur as source of truth
1 parent fd55c41 commit 71e71ce

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

PACKAGING.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The `packaging/` directory holds **templates** (and pinned checksums for the cur
1010
| **Scoop** (Windows) | [Bucket repo](https://github.com/Cod-e-Codes/scoop-marchat) | `scoop bucket add marchat https://github.com/Cod-e-Codes/scoop-marchat` then `scoop install marchat` |
1111
| **winget** (Windows) | Listed in [microsoft/winget-pkgs](https://github.com/microsoft/winget-pkgs) after merge; track [PR #358094](https://github.com/microsoft/winget-pkgs/pull/358094) while pending | `winget install Cod-e-Codes.Marchat` |
1212
| **Chocolatey** | Not published from this repo yet; see `packaging/chocolatey/` | N/A |
13-
| **AUR** | Not published from this repo yet; see `packaging/aur/` | Use your helper or `yay`/`paru` once a package exists |
13+
| **AUR** (Arch) | [marchat-bin](https://aur.archlinux.org/packages/marchat-bin) on the AUR | `yay -S marchat-bin` or `paru -S marchat-bin` (or any AUR helper) |
1414

1515
Other install paths (zip, `install.sh` / `install.ps1`, Docker) stay in [README.md](README.md).
1616

@@ -22,7 +22,8 @@ Other install paths (zip, `install.sh` / `install.ps1`, Docker) stay in [README.
2222
| `packaging/winget/manifests/...` | winget multi-file manifest set |
2323
| `packaging/scoop/marchat.json` | Scoop manifest |
2424
| `packaging/chocolatey/` | Chocolatey nuspec and install scripts |
25-
| `packaging/aur/PKGBUILD` | AUR `-bin` style package |
25+
| `packaging/aur/PKGBUILD` | Canonical AUR package definition (edit here first) |
26+
| `packaging/aur/.SRCINFO` | AUR metadata; regenerate on Arch with `makepkg --printsrcinfo > .SRCINFO` whenever `PKGBUILD` changes |
2627

2728
## Release alignment
2829

@@ -56,7 +57,13 @@ Templates live in `packaging/chocolatey/`. Building: `choco pack` in that direct
5657

5758
## AUR
5859

59-
Template: `packaging/aur/PKGBUILD` (binary package from official linux-amd64 and linux-arm64 zips). Publishing requires an [AUR account](https://aur.archlinux.org/), SSH key on the account, and a `.SRCINFO` generated with `makepkg --printsrcinfo` on Arch. Follow [AUR submission guidelines](https://wiki.archlinux.org/title/AUR_submission_guidelines). The canonical `PKGBUILD` for copying into the AUR Git repo is the one in this tree.
60+
**Package:** [marchat-bin](https://aur.archlinux.org/packages/marchat-bin) (`marchat-client`, `marchat-server` from official linux-amd64 / linux-arm64 release zips).
61+
62+
**In this repo:** Maintain `packaging/aur/PKGBUILD` and `packaging/aur/.SRCINFO`. After any `PKGBUILD` edit, regenerate `.SRCINFO` on an Arch system (`makepkg --printsrcinfo > .SRCINFO` in that directory).
63+
64+
**Publishing updates:** Push `PKGBUILD` and `.SRCINFO` to the AUR with Git over SSH ([guidelines](https://wiki.archlinux.org/title/AUR_submission_guidelines#Submitting_packages)). Your account needs an SSH key on [aur.archlinux.org](https://aur.archlinux.org/).
65+
66+
**Verify build (Docker on Windows):** `docker run --rm archlinux:latest bash -lc "pacman -Sy --noconfirm --needed base-devel git && useradd -m build && su build -c 'cd /home/build && git clone https://aur.archlinux.org/marchat-bin.git && cd marchat-bin && makepkg -f --noconfirm'"`
6067

6168
## Install scripts and CI
6269

packaging/aur/.SRCINFO

Whitespace-only changes.

0 commit comments

Comments
 (0)