pantry/README.md

This pantry† represents the most essential open source packages in the world. We promise to prioritize fixes, updates and robustness for these packages. We will not lightly accept additions, and thus suggest submitting your pull request against pantry.extra first.

† see pantry.zero for “what is a pantry”

Use with tea/cli

tea/cli clones/updates this pantry and pantry.extra when installed with the installer or when you run tea --sync. At this time pantries are not versioned.

 

Contributing

Assuming you have tea+magic installed:

$ git clone https://github.com/teaxyz/pantry.core

$ cd pantry.core

$ pkg init
# ^^ creates a “wip” package.yml

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

$ pkg build
# ^^ runs the build script from your package.yml
# refer to other packages for examples
# ^^ usually requires a (zero permissions) GitHub [PAT]
# either set `$GITHUB_TOKEN` or run `gh auth login` (once) first
# builds in `./srcs`, installs to `~/.tea`

$ pkg test
# ^^ runs the test script from your package.yml
# refer to other packages for examples
# ^^ operates in `./tests`

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

• pkg can be run without magic via tea -E pkg (this dev-env provides +tea.xyz/brewkit).
• gh can be run without magic via tea gh.
• git can be run without magic via tea git.
• 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

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.

tea 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.