Merge pull request #3 from hankei6km/topic/test-release-event

 Change workflow

Author: hankei6km

.github/workflows/npm_pkg.yaml

@@ -2,20 +2,49 @@
 name: Node.js Package
 on:
   release:
-    types: [created]
+    # draft から publish への対応でサンプルの created から変更
+    types: [published]
 jobs:
   build:
     runs-on: ubuntu-latest
     environment: npm_pkg
+
     steps:
     - uses: actions/checkout@v2
+
     # npm に公開するように .npmrc ファイルを設定する
     - uses: actions/setup-node@v2
       with:
         node-version: '14.x'
         registry-url: 'https://registry.npmjs.org'
-    - run: npm install
-      # prepublishOnly を外してここで明示的に buiuld の方が良いか
+
+    # https://docs.github.com/ja/free-pro-team@latest/actions/guides/caching-dependencies-to-speed-up-workflows
+    - name: Cache node modules
+      uses: actions/cache@v2
+      env:
+        cache-name: cache-node-modules
+      with:
+        # npm キャッシュファイルは Linux/macOS の「~/.npm」に保存される
+        path: ~/.npm
+        key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+        restore-keys: |
+          ${{ runner.os }}-build-${{ env.cache-name }}-
+          ${{ runner.os }}-build-
+
+    # https://dev.classmethod.jp/articles/github-actions-npm-automatic-release/
+    # activity type を published へ変更したので念の為
+    - name: can-npm-publish
+      run: npx can-npm-publish
+
+    - name: Install modules
+      run: npm ci
+
+    - name: Run tests
+      run: npm run test
+
+    - name: Build
+      run: npm run build
+
     - run: npm publish
       env:
         NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yaml

@@ -2,8 +2,10 @@
 name: test
 on:
   push:
-    branches_ignore:
-      - master
+    branches:
+      - '**'
+    tags:
+      - '!v*'
 jobs:
 
   jest:

README.md

@@ -1,15 +1,16 @@
 # my-starter-npm-cli-and-lib
 
-typescript で npm 用の CLI とライブラリのパッケージを作成するスターター。
+TypeScript で npm 用の CLI とライブラリのパッケージを作成するスターター。
+CodeSandbox 上でコードを編集し、GitHub Actions から npm レジストリーへ publish することを想定している。
 
 ## 利用方法
 
 まだ記述の途中。
 
 1. GitHub から import する(GitHubBox からは https://githubbox.com/hankei6km/my-starter-npm-cli-and-lib)
 1. fork
-1. `package.json` の `name` `version` `description` `license` 、`LICENSE` あたりを新しいパッケージにあわせて変更。
-1. 新しい terminal を開き `$ npm run upgrade-interactive` 等でパッケージを更新。
+1. `package.json` の `name` `version` `description` `license` 、`LICENSE` あたりを新しいパッケージにあわせて変更
+1. 新しい terminal を開き `$ npm run upgrade-interactive` 等でパッケージを更新
 
 これで 'npm run csb:test'(`jest --watchAll`) が terminal(「yarn start」タブ) 内で実行される。
 
@@ -21,20 +22,30 @@ typescript で npm 用の CLI とライブラリのパッケージを作成す
 - コマンドのフラグ等を変更: `src/main.ts` を編集。
 - コマンドの処理を変更: `src/cli.ts` を編集。
 
-### ライブラリ部分の変更
+### ライブラリー部分の変更
 
 `src/count.ts` を削除し、ライブラリのコードを記述。エクスポートしたい項目を `src/index.ts` へ記述。
 
+### npm publish
+
+GitHub で Release を Publish するとビルド実行後に `npm pulish` される。
+
+なお、`prepublishOnly` 等は定義されていないので、手動で `npm publish` 等を実行してもビルドはされないので注意。
+
+
 ## 既知の問題
 
 ## 参考
 
 - [TypeScript で npm ライブラリ開発ことはじめ - Qiita](https://qiita.com/saltyshiomix/items/d889ba79978dadba63fd)
 - [TypeScript で CLI ツールを作って、npm パッケージにする - Qiita](https://qiita.com/suzuki_sh/items/f3349efbfe1bdfc0c634)
 - [yarn upgrade-interactive と同じように npm でも対話型な更新をしたい！ - Qiita](https://qiita.com/kotarella1110/items/08afeb61d493829711eb)
+- [Node.jsパッケージの公開 - GitHub Docs](https://docs.github.com/ja/actions/guides/publishing-nodejs-packages)
+- [GitHub Actionsでnpmに自動でリリースするworkflowを作ってみた | DevelopersIO](https://dev.classmethod.jp/articles/github-actions-npm-automatic-release/)
 
 ## ライセンス
 
 MIT License
 
 Copyright (c) 2021 hankei6km
+

package.json

@@ -15,7 +15,6 @@
     "start:watch": "nodemon --watch src --ext ts --exec ts-node src/main.ts",
     "build": "tsc",
     "test": "jest",
-    "prepublishOnly": "npm run build",
     "clean": "rm dist/*",
     "upgrade-interactive": "npm-check --update",
     "csb:test": "npm test -- --watchAll"