From 94a87d1e91eed8637c37e9175294b002ed4cc119 Mon Sep 17 00:00:00 2001 From: gawaooooo Date: Wed, 8 May 2024 12:39:58 +0900 Subject: [PATCH] docs: remove unused document --- docs/npm-auto-bump.md | 38 -------------------------------------- 1 file changed, 38 deletions(-) delete mode 100644 docs/npm-auto-bump.md diff --git a/docs/npm-auto-bump.md b/docs/npm-auto-bump.md deleted file mode 100644 index 6d8cd70..0000000 --- a/docs/npm-auto-bump.md +++ /dev/null @@ -1,38 +0,0 @@ - - - - -## Description - -このアクションは、GitHubのラベルに基づいてNPMパッケージのバージョンを自動的にアップデートし、更新されたパッケージファイルをリポジトリにプッシュします。 - -`release/patch`、`release/minor`、`release/major`のいずれかのラベルがプルリクエストに適用された場合に使用します。 - -## Usage -以下のようにワークフローに組み込んで使用します。 - -`label-name`には、プルリクエストに適用されたバージョン更新用のラベルを指定し、必要に応じて`checkout-ref`を指定して、特定のGitリファレンスから作業を開始することができます。 - -```yaml -steps: - - name: Bump version and push package files - uses: gawaooooo-sandbox/learn-github-actions-custom/composite/npm-auto-bump@v0 # This is the version of the action - with: - label-name: 'release/patch' -``` - -## Inputs - -| Name | Description | Default | Required | -| :--- | :---------- | :------ | :------: | -| label-name | 
バージョンを更新するラベル名
release/(patch|minor|major) のいずれかを指定します
| n/a | yes | -| checkout-ref | 
チェックアウトするリファレンス
| `${{ github.head_ref || github.ref }}` | no | -| node-version-file | 
Node.jsのバージョンを指定するファイルのパス
| `.nvmrc` | no | - -## Outputs - -N/A - - - -