Platform Application Capabilities Kit (PACK)

This repository is a monorepo for the Platform Application Capabilities Kit (PACK) TypeScript packages. These capabilities are in ALPHA state and not intended for production use.

Dev workflow

1. Fork the repo

2. Create a branch

3. pnpm install

4. Add your code

5. Run all lint rules and tests with pnpm check from root. Run pnpm turbo typecheck to quickly check any issues with your types.

6. Add a changeset

   📘 Note Follow semver rules here.

   1. Assuming you've run pnpm install, run changeset (or pnpm exec changeset).
   2. The tool will split things into changed vs unchanged packages (which you may need if you decide to add changeset logs in a future PR for past features)
   3. Select the packages you want the changeset applied to using the arrow keys (up/down) and space-bar to "select" the package.
   4. Press enter to continue.
   5. The CLI will go through a progression of asking you which packages you previously selected need a major bump? Then a minor bump? Patch bumps assumed for remaining packages changed. Arrows and space bar to select. Enter to continue (even if you selected nothing).
   6. Enter a change (or press enter on empty to open your editor.)

   Info Full docs on the changesets tool can be found at the changesets/changesets github repo.

7. If you're curious what the final build output might look like you can run pnpm build from root.

Documentation

The documentation site lives in docs/ and is built with Docusaurus (package @palantir/pack.docs). Pages are Markdown under docs/; the navigation is defined in docs/sidebars.ts.

1. pnpm install
2. Edit or add Markdown pages in docs/ (register new pages in docs/sidebars.ts).
3. Preview locally with hot reload: pnpm --filter @palantir/pack.docs start (serves at http://localhost:3000/pack/).
4. Produce a production build: pnpm --filter @palantir/pack.docs build, then preview it with pnpm --filter @palantir/pack.docs serve. The build fails on broken internal links, so run it before opening a PR.

Docs are deployed to GitHub Pages automatically by .github/workflows/deploy-docs.yml when changes under docs/** land on develop.

Publishing

1. Install the GitHub CLI
2. gh auth login to authenticate with github.com
3. pnpm install
4. ./scripts/createReleasePr.sh
5. Once your release PR has been merged, run /scripts/tag-release.sh [COMMIT_SHA] to tag your release.

---

License

This project is made available under the Apache 2.0 License.