Merge pull request #8 from hankei6km/topic/fix-readme-workflow

Fix README and workflow

Author: hankei6km

.github/workflows/npm_pkg.yaml

@@ -14,11 +14,7 @@ jobs:
     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, '-') }}
+      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 }}'

README.md

@@ -1,13 +1,13 @@
-# my-starter-npm-cli-and-lib
+# my-starter-ts-npm-cli-and-lib
 
 TypeScript で npm 用の CLI とライブラリのパッケージを作成するスターター。
-CodeSandbox 上でコードを編集し、GitHub Actions から npm レジストリーおよび GitHub Packages へ publish することを想定している。
+CodeSandbox 上でコードを編集し、GitHub Actions から  GitHub Packages および npm レジストリーへ publish することを想定している。
 
 ## 利用方法
 
 このリポジトリをテンプレートとして新しいリポジトリを作成する。
 
-1. `$ gh repo create <name> --template https://github.com/hankei6km/my-starter-npm-cli-and-lib` でリポジトリ作成
+1. `$ gh repo create <name> --template https://github.com/hankei6km/my-starter-ts-npm-cli-and-lib` で作成
 1. `package.json` と `LICENSE` 等を新しいパッケージにあわせて変更(付録にテンプレート)
 1. `$ npm run upgrade-interactive` 等でパッケージを更新
 
@@ -27,7 +27,10 @@ CodeSandbox 上でコードを編集し、GitHub Actions から npm レジスト
 
 ### npm publish
 
-以下の設定後に GitHub で Release を Publish すると `npm publish` される。
+以下の設定後に GitHub で Release を Publish すると Relase の種類により GitHub Pages または npm レジストリーへ `npm publish` される。
+
+- Pre Release: GitHub Pages のみに publish される
+- Release: GitHub Pages および npm レジストリーへ publish される
 
 なお、`prepublishOnly` 等は定義されていないので、手動で `npm publish` を実行してもビルドはされないので注意。
 
@@ -38,26 +41,26 @@ CodeSandbox 上でコードを編集し、GitHub Actions から npm レジスト
 
 現状では、`gh_pkg` への設定変更は行わない。
 
-#### npm レジストリーへ publish
-
-GitHub で Release を Publish すると `npm publish` される。ただし Pre Release のときは Publish されない。
+#### GitHub Packages へ publish
 
-なお、`npm publish` に ` --access public` は指定されていないので、scope を利用する場合は注意。
+GitHub で Release を Publish すると `npm publish` される。このとき、scope はリポジトリの所有者(`$GITHUB_REPOSITORY` の所有者部分)へ置き換えられる。
 
 ```console
-$ npm version patch
+$ npm version prerelease
 $ git push origin
-$ gh release create v0.1.2 -t 0.1.2
+$ gh release create v0.1.2-5 -t 0.1.2-5 --target <branch>
 ```
 
-#### GitHub Packages へ publish
+#### npm レジストリーへ publish
 
-GitHub で Release を Publish すると `npm publish` される。このとき、scope はリポジトリの所有者(`$GITHUB_REPOSITORY` の所有者部分)へ置き換えられる。
+GitHub で Release を Publish すると `npm publish` される。ただし Pre Release のときは Publish されない。
+
+なお、`npm publish` に ` --access public` は指定されていないので、scope を利用する場合は注意。
 
 ```console
-$ npm version prerelease
+$ npm version patch
 $ git push origin
-$ gh release create v0.1.2-5 -t 0.1.2-5 --target <branch>
+$ gh release create v0.1.2 -t 0.1.2
 ```
 
 ## 付録
@@ -94,3 +97,5 @@ MIT License
 
 Copyright (c) 2021 hankei6km
 
+
+