npm-oidc-example

GitHub Actions + OIDC を使って npmjs へ publish する最小構成のサンプルです。

リリース運用（自動化）

このリポジトリは Release Please を使い、main への変更からリリースPRを自動作成します。 PR をマージするとタグ vX.Y.Z が作成され、publish ワークフローが起動します。

※ vX.Y.Z タグで npm-publish を確実に起動させるため、Release Please には RELEASE_PLEASE_TOKEN（PAT）が必須です。 GITHUB_TOKEN で作られたタグは別Workflowを起動できないため、publishが動きません。

flowchart TD
  A[mainへコミット] --> B[Release PleaseがリリースPR作成]
  B --> C[リリースPRをマージ]
  C --> D[タグ vX.Y.Z 作成]
  D --> E[GitHub Actions: npm publish (OIDC)]
  E --> F[npmjsに公開]

バージョンの決まり方（Conventional Commits）

コミットメッセージの種類でバージョンが決まります。

| 例 | 変更の種類 | 上がり方 | | --- | --- | --- | | fix: ... | 修正 | patch | | feat: ... | 機能追加 | minor | | feat!: ... / BREAKING CHANGE: | 破壊的変更 | major |

明示的に指定したい場合は、コミット本文に Release-As: x.y.z を入れます。

コミットルールの強制

PR 作成時に commitlint が実行され、Conventional Commits に違反していると失敗します。 ブランチ保護で必須チェックに設定すると、ルール違反のコミットをマージできません。

OIDC publish の前提

npmjs 側で Trusted Publishing（GitHub Actions）を設定しておく必要があります。 初回だけ手動 publish（OTP 必須）が必要になる場合があります。

テスト

Release Please 動作確認のための変更を適宜追加します。 Release PR を作るには feat: か fix: のコミットが必要です。