diff --git a/README-ja.md b/README-ja.md index 84171e9..d8ede09 100644 --- a/README-ja.md +++ b/README-ja.md @@ -424,12 +424,15 @@ npm run version:major # 破壊的変更用 (2.0.0 -> 3.0.0) - **Pull Request チェック**: 全PRで自動的な品質チェック、テスト、ビルドを実行 - **自動リリース**: gitタグをプッシュすると(`npm run version:*`経由)、GitHub Actionsが自動で: + - `NPM_TOKEN` シークレットが設定済みかつ有効かを最初に検証(無効なら以降のステップを実行せず即fail) - 完全なテストスイート実行(ユニット + ブラウザテスト) - 全形式ビルド - - NPMへの自動公開 - - アーティファクト付きGitHub Release作成 + - NPMへの公開 + - GitHub Release作成(NPM公開成功後にのみ実行) - CHANGELOG.mdからのリリースノート生成 +> **再実行について**: NPM公開より前のステップ(トークン検証失敗・テスト失敗など)で落ちたリリースは、副作用が無いためGitHub ActionsのUIから安全に再実行できます。NPM公開を先・GitHub Release作成を後にすることで、公開失敗時に孤立したReleaseが残らないようにしています。 + ### NPM自動公開の設定 NPMへの自動公開を有効にするため、リポジトリメンテナは以下の設定が必要です: @@ -456,10 +459,11 @@ NPMへの自動公開を有効にするため、リポジトリメンテナは リリースワークフローは自動で以下を実行します: +- ✅ 他のステップを実行する前に `NPM_TOKEN` の設定有無と有効性を検証 - ✅ 品質チェックとテストの実行 - ✅ 全配布形式のビルド - ✅ NPMレジストリへの公開 -- ✅ ダウンロード可能なアーティファクト付きGitHub Release作成 +- ✅ ダウンロード可能なアーティファクト付きGitHub Release作成(NPM公開成功後にのみ実行) - ✅ CHANGELOG.mdからのリリースノート抽出 ## 参照 diff --git a/README.md b/README.md index 2dfb65a..86901e8 100644 --- a/README.md +++ b/README.md @@ -448,12 +448,15 @@ This project uses GitHub Actions for automated testing and releases: - **Pull Request Checks**: Automatic quality checks, tests, and builds on all PRs - **Automated Releases**: When you push a git tag (via `npm run version:*`), GitHub Actions will: + - Verify the `NPM_TOKEN` secret is set and valid (fails fast if invalid) - Run full test suite (unit + browser tests) - Build all formats - - Publish to NPM automatically - - Create GitHub Release with artifacts + - Publish to NPM + - Create a GitHub Release with artifacts (only after NPM publish succeeds) - Generate release notes from CHANGELOG.md +> **Note on re-running**: If a release run fails before NPM publish (e.g. invalid token, failing tests), it can be safely re-run from the GitHub Actions UI without leaving a partial state. The workflow publishes to NPM before creating the GitHub Release so that a failed publish does not produce an orphaned Release. + ### Setting Up NPM Auto-Publishing To enable automated NPM publishing, repository maintainers need to: @@ -480,10 +483,11 @@ To enable automated NPM publishing, repository maintainers need to: The release workflow will automatically: +- ✅ Verify `NPM_TOKEN` is set and valid before doing anything else - ✅ Run quality checks and tests - ✅ Build all distribution formats - ✅ Publish to NPM registry -- ✅ Create GitHub Release with downloadable artifacts +- ✅ Create GitHub Release with downloadable artifacts (after NPM publish succeeds) - ✅ Extract release notes from CHANGELOG.md ## SEE ALSO