action template

アクションテンプレート

これは、リリース自動化を備えた reviewdog アクションのテンプレート リポジトリです。 Use this template 」ボタンをクリックして reviewdog アクションを作成します ?!

このテンプレートを使用せずに独自の reviewdog アクションを最初から作成する場合は、リリース自動化フローを確認してコピーしてください。リリース ワークフローを管理し、すべての reviewdog アクションの reviewdog バージョンを同期することが重要です。

このリポジトリには、スペルミスを実行するサンプル アクションが含まれています。

入力

 inputs :
  github_token :
    description : ' GITHUB_TOKEN '
    default : ' ${{ github.token }} '
  workdir :
    description : ' Working directory relative to the root directory. '
    default : ' . '
  # ## Flags for reviewdog ###
  level :
    description : ' Report level for reviewdog [info,warning,error] '
    default : ' error '
  reporter :
    description : ' Reporter of reviewdog command [github-pr-check,github-check,github-pr-review]. '
    default : ' github-pr-check '
  filter_mode :
    description : |
      Filtering mode for the reviewdog command [added,diff_context,file,nofilter].
      Default is added.
    default : ' added '
  fail_on_error :
    description : |
      Exit code for reviewdog when errors are found [true,false]
      Default is `false`.
    default : ' false '
  reviewdog_flags :
    description : ' Additional reviewdog flags '
    default : ' '
  # ## Flags for <linter-name> ###
  locale :
    description : ' -locale flag of misspell. (US/UK) '
    default : ' ' 

使用法

 name : reviewdog
on : [pull_request]
jobs :
  # TODO: change `linter_name`.
  linter_name :
    name : runner / <linter-name>
    runs-on : ubuntu-latest
    steps :
      - uses : actions/checkout@v4
      - uses : reviewdog/action-template@v1
        with :
          github_token : ${{ secrets.github_token }}
          # Change reviewdog reporter if you need [github-pr-check,github-check,github-pr-review].
          reporter : github-pr-review
          # Change reporter level if you need.
          # GitHub Status Check won't become failure with warning.
          level : warning 

発達

リリース

haya14busa/action-bumpr

特定のラベル (bump:major、bump:minor、bump:patch) を使用してプル リクエストをマージすると、バージョンをバンプできます。自分で手動でタグをプッシュすることもできます。

haya14busa/action-update-semver

このアクションは、タグのプッシュ時にメジャー/マイナー リリース タグを更新します。たとえば、v1.2.3 のリリース時に v1 および v1.2 タグを更新します。参照: https://help.github.com/en/articles/about-actions#versioning-your-action

Lint - reviewdog の統合

この reviewdog アクション テンプレート自体は、Docker コンテナー ベースのアクションに役立つ lint を実行するために reviewdog と統合されています。

サポートされているリンター:

• レビュードッグ/アクションシェルチェック
• reviewdog/アクション-hadolint
• reviewdog/アクションのスペルミス

依存関係更新の自動化

このリポジトリは reviewdog/action-depup を使用して reviewdog のバージョンを更新します。