omacom /omarchy-pkgs

★ 154⑂ 456👁 3⑃ 2,695● 144▤ 0
ShellMITCreated 2025-08-24
+0
日增长
154
stars
456
forks
3
watchers
2,695
prs
144
issues
0
releases

README

Omarchy Package Repository

Recipes and tooling for the packages Omarchy ships from
https://pkgs.omarchy.org//.

- Channels: edge → rc → stable. Packages only move forward.
- Architectures: x86_64 and aarch64.
- Recipes: one directory per package in pkgbuilds//, with a
  PKGBUILD and .omarchy/package.json.

 Contribute a package

Everything a package PR needs is in pkgbuilds//. No secrets or
access are required. To work locally you need:

- git, bash, jq, curl and a tar that reads zstd
- Docker or Podman that your user can run, to build. With Docker, a build
  calls sudo to fix the ownership of its output.
- on Arch, to check an upstream declaration: Python 3.14+, vercmp, bsdtar

Questions and problems: open an issue on this repository.

 Add a new package

1. Fork the repository and branch from master.
2. Create the recipe:

   bash
   bin/add-package my-package --local --scaffold    Starter PKGBUILD and metadata
   bin/add-package my-package --source aur          Or import an AUR recipe once
   

   An imported recipe is Omarchy's from then on; there is no AUR sync.
3. Write pkgbuilds/my-package/PKGBUILD to Arch packaging standards.
   - List every architecture it supports in arch=(): x86_64, aarch64,
     or any. CI builds each one.
   - Pin every git source with commit= or tag=. An unpinned
     source is rejected; tests/pinned-sources.sh checks it locally.
   - Fill the checksums: run updpkgsums (from pacman-contrib) in the
     package directory. For a git source it leaves a clone of the source
     there; delete it before committing.
   - If upstream signs its releases, list the key's full fingerprint in
     validpgpkeys=() and ship the key as
     pkgbuilds/my-package/keys/pgp/.asc, the way Arch does.
     Builds never ask a keyserver, so a key that is not in the file fails
     the build; tests/pgp-keys-vendored.sh checks it locally. Take the
     key from its owner (their site or WKD), and check that its fingerprint
     matches what upstream publishes:

     bash
     gpg --auto-key-locate clear,nodefault,wkd --locate-external-keys [email protected]
     gpg --armor --export-options export-minimal --export  \
        pkgbuilds/my-package/keys/pgp/.asc
     
   - Extract a vendor archive in package() with bsdtar --no-same-owner.
     pacman installs the numeric owners a package records, so every file
     must be owned by root. The build fails on any other owner, or on a
     group other than root, tty, ftp or games.
4. Declare where new releases come from in
   pkgbuilds/my-package/.omarchy/package.json, so updates arrive without
   another PR. See docs/upstream-sources.md.

   json
   {
     "source": "local",
     "upstream": { "watch": { "github": "owner/project", "pattern": "v(?P[0-9]+(?:\\.[0-9]+))" } }
   }
   

   Use this watch form for a new package. The pattern must match the whole
   tag, so drop the v for a project that tags 1.2.3. A github watch
   reads GitHub Releases; for a project that only pushes tags, watch the tags:

Top issues

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON