Read this in other languages: English, 日本語.
npmパッケージ公開前にパッケージのバージョンをチェックするGitHub Actionsです。
Details
-
GitHub Action実行中
-
package.json のバージョンを更新 (ブランチが保護されていない場合)
例：.github/workflows/check_version.yml
on: push
name: Check package version
jobs:
checkVersion:
name: Check package version
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
# Use this GitHub Action
- name: Check package version
uses: technote-space/package-version-check-action@v1
with:
BRANCH_PREFIX: release/例：.github/workflows/release.yml
on:
push:
tags:
- 'v*'
name: Publish Package
jobs:
release:
name: Publish Package
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
# Use this GitHub Action
- name: Check package version
uses: technote-space/package-version-check-action@v1
with:
COMMIT_DISABLED: 1
- name: Install Package dependencies
run: yarn install
- name: Build
run: yarn build
- name: Publish
run: |
npm config set //registry.npmjs.org/:_authToken=$NPM_AUTH_TOKEN
npm publish
env:
NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}ブランチプリフィックス
default: ''
例：release/
コミットが無効かどうか
default: ''
パッケージバージョン更新用コミットのメッセージ
default: 'feat: update package version'
パッケージファイル名
default: 'package.json'
パッケージファイルが置かれたディレクトリ
default: ''
テスト用タグのプリフィックス
default: ''
例：'test/'
次のバージョンを指定
default: ''
e.g. 'v1.2.3'
| eventName: action | condition |
|---|---|
| push: * | condition1 |
| release: published | condition1 |
| pull_request, pull_request_target: opened, reopened, synchronize | condition2 |
| created: * | condition3 |
- tags
- semantic versioning tag (例：
v1.2.3)
- semantic versioning tag (例：
- branches
${BRANCH_PREFIX}${tag}- tag: semantic versioning tag (例：
v1.2.3) - 例：branch:
release/v1.2.3
- tag: semantic versioning tag (例：
- branches
${BRANCH_PREFIX}${tag}- tag: semantic versioning tag (例：
v1.2.3) - 例：branch:
release/v1.2.3
- tag: semantic versioning tag (例：
- tags
- semantic versioning tag (例：
v1.2.3)
- semantic versioning tag (例：
package.jsonバージョンの更新を忘れると、npmパッケージの公開は失敗します。
タグのプッシュでアクションを起動していた場合、
- プッシュしたタグを削除
- package.json のバージョンを更新
- コミットして再度タグを付与
- プッシュ
を再度行う必要があり、非常に面倒です。
この GitHub Action は、タグ名に基づいてpackage.jsonのバージョンを自動的に更新します。
したがって、package.json のバージョンについて心配する必要はありません。
また、ブランチが保護されていない場合、このアクションは変更をコミットします。
ブランチが保護されている場合、このアクションは package.json のバージョンを更新するだけです。
コミットは『タグ付きのデフォルトブランチ(通常はmaster)』または『${BRANCH_PREFIX}から始まるブランチ』へのプッシュ時のみ有効です。
GitHub Actions で提供されるGITHUB_TOKENは連続するイベントを作成する権限がありません。
したがって、プッシュによってトリガーされるビルドアクションなどは実行されません。
これはブランチプロテクションを設定していると問題になる場合があります。
もしアクションをトリガーしたい場合は代わりにpersonal access tokenを使用してください。
- public_repo または repo の権限で Personal access token を生成
(repo はプライベートリポジトリで必要です) - ACCESS_TOKENとして保存
GITHUB_TOKENの代わりにACCESS_TOKENを使用するように設定
例：.github/workflows/check_version.ymlon: push name: Check package version jobs: checkVersion: name: Check package version runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 # Use this GitHub Action - name: Check package version uses: technote-space/package-version-check-action@v1 with: GITHUB_TOKEN: ${{ secrets.ACCESS_TOKEN }} BRANCH_PREFIX: release/
タグ名は Semantic Versioning に従っている必要があります。