/action-release

Primary LanguageJavaScriptMIT LicenseMIT

actions-release

指定されたリポジトリに対して以下の処理を行う Github Actions です。

  • npm モジュールの publish 処理
    • publish時のオプションは、指定されたリポジトリのpackage.jsonのpublishConfigの内容に準拠します。
  • publish 時の バージョンで Github Release Note を作成

入力パラメータ

  • github_token: 対象リポジトリの Github トークン。必須パラメータ
  • npm_token: 対象リポジトリの Npm パッケージの Npm トークン。必須パラメータ

利用例

- name: Checkout repository
  uses: actions/checkout@v2
- name: Publish and Release
  uses: akashic-games/action-release@v1
  with:
    # 基本的にはデフォルトで設定されている秘匿変数GITHUB_TOKENを使用します
    github_token: ${{ secrets.GITHUB_TOKEN }}
    # npmトークンは予め対象のgithubリポジトリに秘匿変数として登録しておくことを推奨します
    npm_token: ${{ secrets.NPM_TOKEN }}
    # CHANGELOG.md 更新時の Git 名 (省略可)
    git_name: github-actions
    # CHANGELOG.md 更新時の Git メールアドレス (省略可)
    git_email: 41898282+github-actions[bot]@users.noreply.github.com
    # 対象リポジトリへの Release Note の生成を抑制するかどうか。省略時は `false` 。
    suppress_release_creation: false

注意点

このアクションを使用する場合、対象のパッケージでは以下の対応が必要になります。

  • スコープ化された公開パッケージの場合、package.jsonのpublishConfig.accessに"public"を指定する必要があります。

ビルド方法

以下のコマンドを実行

npm install
npm run build

上記コマンドによって、dist/index.jsにビルド成果物が生成されます。

デプロイ方法

npm version コマンドにより package.json のバージョンを更新してください。 その後 main ブランチへマージすることで自動的にデプロイされます。

テスト方法

以下のコマンドを実行

npm test

ライセンス

本リポジトリは MIT License の元で公開されています。 詳しくは LICENSE をご覧ください。

ただし、画像ファイルおよび音声ファイルは CC BY 2.1 JP の元で公開されています。