자습서: GitHub 작업을 사용한 린트 코드

https://codecatalyst.aws/에서 CodeCatalyst 콘솔을 엽니다.

codecatalyst-linter-project 프로젝트로 이동합니다.

탐색 창에서 코드를 선택한 다음 소스 리포지토리를 선택합니다.

리포지토리 추가를 선택하고 리포지토리 생성을 선택합니다.

리포지토리 이름에 다음과 같이 입력합니다.

codecatalyst-linter-source-repository

생성(Create)을 선택합니다.

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를 입력합니다. 다른 기본 옵션을 유지합니다.

커밋을 선택합니다.

app.js 새 역할이 생성되었습니다.

CodeCatalyst 콘솔에서 codecatalyst-linter-project 프로젝트를 선택합니다.

탐색 창에서 CI/CD를 선택한 다음 워크플로를 선택합니다.

워크플로 생성을 선택합니다.

소스 리포지토리에서 codecatalyst-linter-source-repository를 선택합니다.

브랜치에서 main을 선택합니다.

생성(Create)을 선택합니다.

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:(소문자)에서 코드를 찾아 CodeCatalyst 워크플로의 Steps:(대문자)에 붙여 넣습니다.

다음 코드와 같이 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 콘솔에서 로그 탭을 선택한 다음 Lint Code Base를 선택합니다.

생성된 슈퍼 린터 작업이 표시되는 로그입니다.

슈퍼 린터 로그에서 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.

소스 리포지토리에서 app.js 및 README.md를 수정하고 변경 사항을 커밋합니다.

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

변경하면 다른 워크플로가 자동으로 실행됩니다. 워크플로가 완료될 때까지 기다립니다. 모든 문제를 해결한 경우 워크플로가 성공해야 합니다.

https://codecatalyst.aws/에서 CodeCatalyst 콘솔을 엽니다.

codecatalyst-linter-source-repository를 삭제합니다.

codecatalyst-linter-workflow를 삭제합니다.