pkg metadata and build instructions.

Contributing

Assuming you have pkgx with shell integration:

$ git clone https://github.com/pkgxdev/pantry

$ cd pantry

$ dev

$ pkg init
# ^^ creates a “wip” package.yml
# ^^ if you already know the name, you can pass it as an argument

$ pkg edit
# ^^ opens the new package.yml in your EDITOR

$ pkg build
# builds to `./builds`
# ^^ needs a zero permissions GITHUB_TOKEN to use the GitHub API
# either set `GITHUB_TOKEN` or run `gh auth login`

$ foo
# ^^ anything in the `provides:` key will now run

$ pkg test
# ^^ you need to write a test that verifies the package works

$ gh repo fork
$ git branch -m my-new-package
$ git push origin my-new-package
$ gh pr create

pkg build and pkg test take a -L flag to run in a Linux Docker container

All commands take an optional pkg-spec eg. pkg build zlib.net^1.1

While inside the pantry dev environment you can run commands from any built packages provided you specified their provides: key.

GitHub Codespaces

pantry also works in GitHub Codespaces. The default configuration provides with the repository will install/update pkgx at the time you attach, so you should be able to quickly work on or test packages in a remote linux environment (or work from a device with just a web browser).

Providers

If the package you want to add to the pantry can be executed simply eg. you want foo to run npx foo, then you can add a one-line entry to npmjs.com/provider.yml.

We currently also support this for pipx. Adding support for other such dependency manager execution handlers is easy and welcome.

At this time, if the package has pkgx dependencies or requires compilation, it should be packaged as a package.yml.

Packaging Guide

Packaging can be cumbersome. Our wiki is our packaging knowledge base. For other assistance, start a discussion.

After Your Contribution

We build “bottles” (tar’d binaries) and upload them to both our centralized bottle storage and decentralized IPFS.

The pantry automatically builds new releases of packages as soon as they are released (usually starting the builds within seconds). There is no need to submit PRs for updates.

Working on Other People’s Pull Requests

Packaging can be fiddly so we all pitch in. If you want to help someone else with their pull request then you can use GitHub’s CLI: