GitHub Actions のクイックスタート

GitHub Actions の支払いを管理する GitHubは、macOSランナーのホストにMacStadiumを使用しています。

はじめに

GitHub Actions ワークフローを作成して実行するには、既存の GitHub リポジトリのみが必要です。 このガイドでは、GitHubSuper-Linter アクションを使用して複数のコーディング言語の文法チェックを行うワークフローを追加します。 ワークフローは Super-Linter を使用して、新しいコミットがリポジトリにプッシュされるたびにソースコードを検証します。

最初のワークフローを作成する

1. GitHub のリポジトリから、superlinter.yml という名前の新しいファイルを .github/workflows ディレクトリに作成します。 詳細は「新しいファイルを作成する」を参照してください。

2. 次の YAML コンテンツを superlinter.yml ファイルにコピーします。 注釈: デフォルトブランチが main でない場合は、リポジトリのデフォルトブランチ名と一致するように DEFAULT_BRANCH の値を更新してください。

   YAML

   name: Super-Linter
   
   # 新しいコミットがリポジトリにプッシュされるたびにこのワークフローを実行する
   on: push
   
   jobs:
     # ジョブキーを設定する。 ジョブ名が指定されていない場合、
     # キーはジョブ名として表示される
     super-lint:
       # ジョブ名を付ける
       name: Lint code base
       # 実行するマシンのタイプを設定する
       runs-on: ubuntu-latest
   
       steps:
         # ubuntu-latest マシンでリポジトリのコピーをチェックアウトする
         - name: Checkout code
           uses: actions/checkout@v2
   
         # Super-Linter アクションを実行する
         - name: Run Super-Linter
           uses: github/super-linter@v3
           env:
             DEFAULT_BRANCH: main
             GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

3. ワークフローを実行するには、ページの一番下までスクロールし、[Create a new branch for this commit and start a pull request] を選択します。 次に、[Propose new file] をクリックしてプルリクエストを作成します。

   

リポジトリ内のワークフローファイルをコミットすると、push イベントがトリガーされ、ワークフローが実行されます。

ワークフローの結果を表示する

1. GitHubで、リポジトリのメインページにアクセスしてください。

2. リポジトリ名の下でActions（アクション）をクリックしてください。

   

3. 左のサイドバーで、表示させたいワークフローをクリックしてください。

   

4. From the list of workflow runs, click the name of the run you want to see.

   

5. 左サイドバーで、[Lint code base] をクリックします。

   

6. Any failed steps are automatically expanded to display the results.

   

その他のスターターワークフロー

GitHub では、事前設定されたワークフローテンプレートが用意されており、継続的インテグレーションワークフローの自動化や作成が可能です。 actions/starter-workflows リポジトリ。

次のステップ

追加した super-linter ワークフローは、コードがリポジトリにプッシュされるたびに実行され、コードのエラーや不整合を見つけます。 ただし、これは GitHub Actions でできることの一部にすぎません。 リポジトリには、さまざまなイベントに基づいてさまざまなジョブをトリガーする複数のワークフローを含めることができます。 GitHub Actions は、アプリケーション開発プロセスのほぼすべての要素を自動化するのに役立ちます。 開始する場合、 GitHub Actions で次のステップに進む際に役立つ、以下のようなリソースを参照してください。

• 詳細なチュートリアルは、「GitHub Actionsを学ぶ」
• 特定の使用例とサンプルについては、「ガイド」
• Super-Linter アクションの設定の詳細については、github/super-linter