Skip to content

WORKFLOWS.md

Latest commit

 

History

History
55 lines (35 loc) · 1.89 KB

WORKFLOWS.md

File metadata and controls

55 lines (35 loc) · 1.89 KB

Workflows

This document describes the GitHub Actions workflows and common development procedures for promptopskit.

GitHub Actions

CI (.github/workflows/ci.yml)

Runs on every push to main and on pull requests (ignoring docs/website/markdown changes). Release bump commits created by the release:* scripts are skipped so tagging a version does not run CI twice.

  • Tests against Node 20 and 22
  • Steps: npm ci → lint → test → build → publint → attw

Publish (.github/workflows/publish.yml)

Runs automatically when a tag matching v* is pushed.

  • Steps: npm ci → lint → test → build → publint → attw → npm publish --access public
  • Publishes to npm using the repository's NODE_AUTH_TOKEN secret

Do not run npm publish locally. The Action handles it.

Deploy Website (.github/workflows/website.yml)

Runs when website/ or docs/ files change on main, or via manual dispatch.

  • Copies docs/*.md into website/docs/
  • Syncs the website/ directory to S3
  • Invalidates the CloudFront cache

Publishing a New Version

  1. Make sure you're on main with a clean working tree.

  2. Bump the version:

    npm run release:patch   # bug fixes (0.1.1 → 0.1.2)
npm run release:minor   # new features (0.1.1 → 0.2.0)
npm run release:major   # breaking changes (0.1.1 → 1.0.0)

    This updates package.json, creates a [release] git commit, and creates a v* tag.

  3. Push the commit and tag:

    git push --follow-tags

  4. The Publish Action triggers automatically, runs all checks, and publishes to npm.

  5. Monitor the run at https://github.com/PredictabilityAtScale/promptopskit/actions to confirm it succeeds.

We keep the push outside the release:* scripts so the remote-changing step stays explicit and reviewable.

That's it — two commands: npm run release:*, git push --follow-tags.