[CI] SwiftLint Github Action 적용기

 

하이! 오늘은 내가 예전부터 진짜진짜 사용해보고싶었던 Github action 적용기에 대해서 작성해볼것이다.
애플 디벨로퍼 아카데미에서 마지막 프로젝트를 진행할 때 갓.듀.나 가 github action에 lint와 빌더를 적용해줘서, pr을 날릴때마다 아주 간편하게! 나의 코드들을 확인할 수 있었다. (빌드테스트와 린트가 잘 적용됐는지!)

우선, Lint를 액션에 적용하게 되면, PR을 날릴대마다 나의 코드에서 Swift Lint 규칙이 잘 적용되어있는지 깃허브 액션에서 확인해준다!

PR을 날리면, 요로코롬 댓글로 린트 Success!!! 라고 알려준다. 만약, 린트에 어긋나는 사항이 있으면, 댓글도 달리지 않고, 밑에 대왕만한 ❌표시가 뜨게 된다. 

🟣 적용하고 좋았던 점

프로젝트 내부에 쓸데없는 warning을 보지 않아도 된다.

린트를 적용해본사람이라면 알것이다. TODO, MARK 주석에도 전부 warning이 뜨고, 사사건건 전부다!!!!! warning으로 린트경고를 준다. 프로젝트가 커지면 커질수록, critical한 에러도 아닌데 무수히 많은 경고들을 만나게 된다. 그러면서 결국 critical한 에러가 묻히게 되겠지..?

lint를 github action에서 확인하게 함으로써, 이런 불편함을 줄일 수 있었다. critical한 린트에러 일 경우, 직접 pr에서 merge를 막아주기 때문에 critical한 에러 말고 자잘한 warning들은 그냥 넘길 수 있다. 

편하다.

프로젝트를 커밋하기 전, 항상 lint를 지켰나 확인하는 과정이 필요했다. 왜냐면.. warning이 기본 10개 이상 뜨기 때문에!! 물론 이렇게 하나하나 전부 검토하는게 좋은 습관이긴 하지만, 이 모든 검사들을 자동으로 진행해주기 때문에 정말 편했다. 점차,, CI에 관심이 가기 시작했다. . 두근두근

---

🟣 시작하며

야심차게 '동식이(개인 프로젝트)' 개발을 시작하려고 한다. 지금은 시작하기 전, 프로젝트 setting 단계..! 이전에 면접에서 개발문화와 관련한 질문이 들어왔을때, Lint에 대한 이야기를 나눈 적이 있는데 Human이 지키려고 노력한 것이냐, CI를 적용해서 사용해본것이냐라는 질문을 받은 적이 있었다.

그저 나는, Human error를 직접 수정하는 방안으로 사용했다고 대답했고, 그 이후 EarthValley80프로젝트에서 듀나가 설정해준 lint Action을 보고 꼭 직접 해보고싶은 마음이 들었었다.

듀나가 잘 정리해준 글, 그리고 인터넷의 글을 보고 나의 프로젝트에 적용해보자!

🟣 SwiftLint를 Action에 적용하기

• 프로젝트에 적용하다보면, 너무 많은 Warning 들이 뜬다. TODO , MARK 를 달아놓은 것들에도 다 Warning이 뜨기 때문이다!!! 정작 정말 critical한 문제가 무엇인지 잘 인식이 안된다는 문제점이 있다.

프로젝트 내부에다가 lint를 추가하는 방법도 있지만, 이미 마켓 플레이스에 나와있는 SwiftLint가 존재한다. 해당 링크는 SwitLint를 Github Action에서 사용할 수 있도록 나와있다.

https://github.com/norio-nomura/action-swiftlint

GitHub - norio-nomura/action-swiftlint: GitHub Action for SwiftLint

리드미에 사용 방법이 잘 나와있다.

1️⃣ swiftlint.yml 파일 생성

해당 파일을 이 위 경로에 생성해주자. 내부는 아래처럼 생겼다.

name: auto PR swiftLint

on:
  pull_request:
    branches: [ develop ]
    paths:
      - '.github/workflows/swiftlint.yml'
      - '.swiftlint.yml'
      - '**/*.swift'

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v1
    - name: GitHub Action for SwiftLint
      uses: norio-nomura/action-swiftlint@master
      env:
        DIFF_BASE: ${{ github.base_ref }}

    - name: Add PR Comment
      if: ${{ success() }}
      uses: mshick/add-pr-comment@v1
      with:
        message: |
         ## All File Checked ✅
         | ✅ 	| Auto Pull Request SwiftLint Success!!!! 	|
         |---	|----------------------------------------------	|
        repo-token: ${{ secrets.ACCESS_TOKEN }}
        repo-token-user-login: 'github-actions[bot]' # The user.login for temporary GitHub tokens
        allow-repeats: false # This is the default

 

2️⃣ ACCESS_TOKEN 설정

repo-token: ${{ secrets.ACCESS_TOKEN }}

이 부분에 내 repo의 access token을 넣어주어야 한다. 그래야 PR을 올렸을때, 접근 권한을 얻어서 댓글을 자동으로 달아줄 수 있다.

ACCESS_TOKEN을 발급받는 경로는 Github 내부 Setting에서 가능하다.

💁🏻 경로!!
Settings** > **Secrets and Variables** > **Actions** -> New repository secret

title를 ACCESS_TOKEN으로 설정해주었다. 이렇게 하게 되면,

secrets.ACCESS_TOKEN

으로 토큰값을 가져올 수 있다.

Secret안에 있는 값은, 나의 Github AccessToken 값을 넣어줄 것이다. 발급받는 방법은

 

1. 이미지 옆 사진 클릭 후 Settings 클릭
2.왼쪽 메뉴 맨 밑, Developer Settings 클릭

3. Personal access tokens → Token (Clasic) → Generate New token 클릭
4. 옵션은,, classic으로 … 그냥..

 

5. 토큰도 자주 바꿔줘야 좋지만 나는 귀찮으니까 일단 기간 만료 없이 토큰을 생성했다. 그리고 토큰은 딱 한 번 만 보여주기 때문에 토큰을 따로 메모장에 정리해두는 것이좋다고 한다. .(이전에 안해놨는데 지금부터라도 해놔야지,,,) 옵션은 repo만 클릭했다.

이렇게 이제 생성된 토큰을 Secrets에 넣어주자.

이 부분까지 설정하면, PR를 날릴 때마다 github-action[bot]이 레포에 대한 권한을 받아서 Swiftlint에 대한 검사를 진행하게 된다.

3️⃣ 두근두근 이제 PR을 날려보자.

지금까지 생성된 모든 것들을 기반으로 일단 PR을 날리고, 해당 PR에 린트봇이 댓글을 달면, 무사히 완료가 된 것이다. 두근……하.. action이 돌아가려고 드릉드릉 한다. 🚨🥶

 

오 오오 오오오오옹 됏따!!!

 

오예~ 생각보다 간단했다. 이제, lint를 action에 적용하는 방법은 알았으니!! builder를 적용해보자. 허허허 

 

📚 참고 레퍼런스 - 갓듀의 공유자료

https://github.com/DeveloperAcademy-POSTECH/MacC-Team-EarthValley80/discussions/5

[ARCHIVE] Github Action 단단히 알아가기 · Discussion #5 · DeveloperAcademy-POSTECH/MacC-Team-EarthValley80