チュートリアル: アクションを使用してコードをリントする GitHub

https://codecatalyst.aws/ で CodeCatalyst コンソールを開きます。

プロジェクト に移動しますcodecatalyst-linter-project。

ナビゲーションペインで [コード] を選択してから、[ソースリポジトリ] を選択します。

[リポジトリの追加] を選択し、[リポジトリの作成] を選択します。

リポジトリ名 で、次のように入力します。

codecatalyst-linter-source-repository

[作成] を選択します。

CodeCatalyst コンソールで、プロジェクト を選択しますcodecatalyst-linter-project。

ナビゲーションペインで [コード] を選択してから、[ソースリポジトリ] を選択します。

ソースリポジトリのリストから、リポジトリ を選択しますcodecatalyst-linter-source-repository。

ファイル で、ファイルの作成 を選択します。

テキストボックスに、次のコードを入力します。

// const axios = require('axios')
// const url = 'http://checkip.amazonaws.com/';
let response;
/**
 *
 * Event doc: https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-simple-proxy-for-lambda-input-format
 * @param {Object} event - API Gateway Lambda Proxy Input Format
 *
 * Context doc: https://docs.aws.amazon.com/lambda/latest/dg/nodejs-prog-model-context.html 
 * @param {Object} context
 *
 * Return doc: https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html
 * @returns {Object} object - API Gateway Lambda Proxy Output Format
 *
 */
exports.lambdaHandler = async (event, context) => {
  try {
    // const ret = await axios(url);
    response = {
      statusCode: 200,
      'body': JSON.stringify({
        message: 'hello world'
        // location: ret.data.trim()
      })
    }
  } catch (err) {
    console.log(err)
    return err
  }

    return response
}

ファイル名 には、 と入力しますapp.js。その他のデフォルトオプションはそのままにしておきます。

[Commit] (コミット) を選択します。

これで、 という名前のファイルが作成されましたapp.js。

CodeCatalyst コンソールで、プロジェクト を選択しますcodecatalyst-linter-project。

ナビゲーションペインで CI/CD を選択し、ワークフロー を選択します。

ワークフローの作成 を選択します。

ソースリポジトリ で、 を選択しますcodecatalyst-linter-source-repository。

ブランチ で、 を選択しますmain。

[作成] を選択します。

YAML サンプルコードを削除します。

次の を追加しますYAML。

Name: codecatalyst-linter-workflow
SchemaVersion: "1.0"
Triggers:
  - Type: PUSH
    Branches:
      - main
Actions:
  SuperLinterAction:
    Identifier: aws/github-actions-runner@v1
    Configuration:
      Steps:
        github-action-code

上記のコードで、github-action-code この手順の次の手順で説明するように、 を Super-Linter アクションコードで使用します。

GitHub Marketplace の Super-Linter ページに移動します。

下 steps:（小文字) でコードを検索し、 Steps: (大文字) でワークフローに CodeCatalyst貼り付けます。

次のコードに示すように、 CodeCatalyst 標準に準拠するように GitHub アクションコードを調整します。

CodeCatalyst ワークフローは次のようになります。

Name: codecatalyst-linter-workflow
SchemaVersion: "1.0"
Triggers:
  - Type: PUSH
    Branches:
      - main
Actions:
  SuperLinterAction:
    Identifier: aws/github-actions-runner@v1
    Configuration:
      Steps:
        - name: Lint Code Base
          uses: github/super-linter@v4
          env:
            VALIDATE_ALL_CODEBASE: "true"
            DEFAULT_BRANCH: main

（オプション) 検証 を選択して、コミットする前にYAMLコードが有効であることを確認します。

コミット を選択し、コミットメッセージ を入力し、リポジトリ codecatalyst-linter-source-repository を選択し、再度コミット を選択します。

これでワークフローが作成されました。ワークフローの実行は、ワークフローの上部で定義されたトリガーが原因で自動的に開始されます。

ナビゲーションペインで CI/CD を選択し、ワークフロー を選択します。

先ほど作成したワークフローを選択します: codecatalyst-linter-workflow。

ワークフロー図で、 を選択しますSuperLinterAction。

アクションが失敗するのを待ちます。この障害は、 linter がコードで問題を検出したために予想されます。

CodeCatalyst コンソールを開いたままにして、 に進みますステップ 4: Super-Linter が検出した問題を修正する。

CodeCatalyst コンソールで、ログタブを選択し、リントコードベース を選択します。

Super-Linter アクションが生成したログが表示されます。

Super-Linter ログで、90 行目付近まで下にスクロールします。ここでは、問題の始まりがわかります。次のようになります。

/github/workspace/hello-world/app.js:3:13: Extra semicolon.
/github/workspace/hello-world/app.js:9:92: Trailing spaces not allowed.
/github/workspace/hello-world/app.js:21:7: Unnecessarily quoted property 'body' found.
/github/workspace/hello-world/app.js:31:1: Expected indentation of 2 spaces but found 4.
/github/workspace/hello-world/app.js:32:2: Newline required at end of file but not found.

ソースリポジトリREADME.mdの app.jsと を修正し、変更をコミットします。

```markdown
Setup examples:
...
```

変更により、別のワークフローが自動的に実行されます。ワークフローが終了するのを待ちます。すべての問題を修正した場合、ワークフローは成功します。

https://codecatalyst.aws/ で CodeCatalyst コンソールを開きます。

を削除しますcodecatalyst-linter-source-repository。

を削除しますcodecatalyst-linter-workflow。