typed-api-spec monorepo

• pkgs/typed-api-spec
  • main module of the typed-api-spec package
  • It can be installed via npm install @notainc/typed-api-spec
• pkgs/docs
  • documentation for the typed-api-spec package
  • hosted on nota.github.io/typed-api-spec/
• examples
  • examples of using the typed-api-spec package

Publishing

v*.*.* 形式のタグを push すると、GitHub Actions によって自動的に以下が実行されます。

1. ncipollo/release-action により GitHub Release が作成される
2. pkgs/typed-api-spec が npm (@notainc/typed-api-spec) に publish される

手順

# 1. リリース用ブランチを作成
git switch -c chore/bump-version

# 2. バージョンを更新
npm version <patch|minor|major> -w pkgs/typed-api-spec

# 3. 変更をコミット & push
git add pkgs/typed-api-spec/package.json package-lock.json
git commit -m "chore: bump version to <version>"
git push origin chore/bump-version

# 4. GitHub 上で PR を作成し、main にマージする

# 5. ローカルで main を最新化し、タグを作成して push
git switch main
git pull origin main
git tag v<version>
git push origin v<version>

タグが push されると、publish.yaml ワークフローが起動し、npm への公開まで自動で行われます。