Support GitHub Packages

Author: hankei6km

.github/workflows/gh_pkg.yaml

@@ -0,0 +1,58 @@
+# https://docs.github.com/ja/actions/guides/publishing-nodejs-packages
+name: Node.js Package(GitHub Packages)
+on:
+  release:
+    # draft から publish への対応でサンプルの created から変更
+    types:
+      - published
+jobs:
+  publish_to_gh_pkgs:
+    runs-on: ubuntu-latest
+    environment: gh_pkg
+
+    steps:
+    - uses: actions/checkout@v2
+
+    # .npmrc ファイルをセットアップして GitHub Packages に公開する
+    - uses: actions/setup-node@v2
+      with:
+        node-version: '14.x'
+        registry-url: 'https://npm.pkg.github.com'
+        # デフォルトはワークフローファイルを所有するユーザまたは Organization
+        # scope: '@hankei6km'
+
+    # 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-
+
+    # package.json を GitHub Packages 用に調整.
+    - name: Change scope
+      run: jq '.name |= (sub("^.+/"; "") | sub("^"; "@"+ (env.GITHUB_REPOSITORY | split("/")[0])  +"/")) ' package.json  > tmp_package.json && mv tmp_package.json package.json
+
+    # https://dev.classmethod.jp/articles/github-actions-npm-automatic-release/
+    # activity type を published へ変更したので念の為
+    # `publishConfig` の書き換えができたらコメント外す.
+    # - 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.GITHUB_TOKEN }}

.github/workflows/npm_pkg.yaml

@@ -1,15 +1,29 @@
 # https://docs.github.com/ja/actions/guides/publishing-nodejs-packages
-name: Node.js Package
+name: Node.js Package(npmjs)
 on:
   release:
     # draft から publish への対応でサンプルの created から変更
-    types: [published]
+    types:
+      - published
 jobs:
-  build:
+  publish_to_npmjs:
+    if: ${{ github.event.release.prerelease ==  false }}
     runs-on: ubuntu-latest
     environment: npm_pkg
 
     steps:
+    # prerelease のような文字が含まれていたら失敗させる.
+    - name: Check name and tag_name
+      if: >
+        ${{ contains(github.event.release.name, 'p') }} || 
+        ${{ contains(github.event.release.tag_name, 'p') }} || 
+        ${{ contains(github.event.release.name, '-') }} || 
+        ${{ contains(github.event.release.tag_name, '-') }}
+      run: |
+        echo 'name: ${{ github.event.release.name }}'
+        echo 'tag_name: ${{ github.event.release.tag_name }}'
+        exit 1
+
     - uses: actions/checkout@v2
 
     # npm に公開するように .npmrc ファイルを設定する

README.md

@@ -1,17 +1,17 @@
 # my-starter-npm-cli-and-lib
 
 TypeScript で npm 用の CLI とライブラリのパッケージを作成するスターター。
-CodeSandbox 上でコードを編集し、GitHub Actions から npm レジストリーへ publish することを想定している。
+CodeSandbox 上でコードを編集し、GitHub Actions から npm レジストリーおよび GitHub Packages へ publish することを想定している。
 
 ## 利用方法
 
-1. GitHub から import する(GitHubBox からは https://githubbox.com/hankei6km/my-starter-npm-cli-and-lib)
-1. fork
+このリポジトリをテンプレートとして新しいリポジトリを作成する。
+
+1. `$ gh repo create <name> --template https://github.com/hankei6km/my-starter-npm-cli-and-lib` でリポジトリ作成
 1. `package.json` と `LICENSE` 等を新しいパッケージにあわせて変更(付録にテンプレート)
-1. 新しい terminal を開き `$ npm run upgrade-interactive` 等でパッケージを更新
-1. ブラウザーをリロードする
+1. `$ npm run upgrade-interactive` 等でパッケージを更新
 
-これで terminal(「yarn start」タブ) 内で `start` スクリプトが実行される(通常はエラーとなる)、後は必要に応じてコードの編集等を行う。
+作成したリポジトリを CodeSandbox でインポートすると terminal(「yarn start」タブ) 内で `start` スクリプトが実行される(通常はエラーとなる)。後は必要に応じてコードの編集等を行う。
 
 テストの実行は CodeSandbox 上では `npm run csb:test` を利用する。コマンドとしての実行を試す場合は `npm run start -- foo.txt` のように実行する。
 
@@ -27,14 +27,39 @@ CodeSandbox 上でコードを編集し、GitHub Actions から npm レジスト
 
 ### npm publish
 
-以下の設定後に GitHub で Release を Publish すると `npm pbulish` される。
-
-1. GitHub にリポジトリを作成
-1. リポジトリの "Settings / Environment" から `npm_pkg` を作成
-1. Environment secrets に `NPM_TOKEN` を追加(内容は npm レジストリの Access Token)
+以下の設定後に GitHub で Release を Publish すると `npm publish` される。
 
 なお、`prepublishOnly` 等は定義されていないので、手動で `npm publish` を実行してもビルドはされないので注意。
 
+#### 設定
+
+1. GitHub 上でリポジトリの "Settings / Environment" から `npm_pkg` および `gh_pkg` を作成
+1. `npm_pkg` の secrets に `NPM_TOKEN` を追加(内容は npm レジストリの Access Token)
+
+現状では、`gh_pkg` への設定変更は行わない。
+
+#### npm レジストリーへ publish
+
+GitHub で Release を Publish すると `npm publish` される。ただし Pre Release のときは Publish されない。
+
+なお、`npm publish` に ` --access public` は指定されていないので、scope を利用する場合は注意。
+
+```console
+$ npm version patch
+$ git push origin
+$ gh release create v0.1.2 -t 0.1.2
+```
+
+#### GitHub Packages へ publish
+
+GitHub で Release を Publish すると `npm publish` される。このとき、scope はリポジトリの所有者(`$GITHUB_REPOSITORY` の所有者部分)へ置き換えられる。
+
+```console
+$ npm version prerelease
+$ git push origin
+$ gh release create v0.1.2-5 -t 0.1.2-5 --target <branch>
+```
+
 ## 付録
 
 `package.json` に記述する情報のテンプレート。`license` を変更したら `LICENSE` ファイルの変更も忘れずに。