Git Action - YAML

협업을 하다가 보니 코드가 합쳐질 때 문제점이 생기고 이런 오류들을 방지를 위해 test_code가 존재했지만, PR이 급한 경우에는 테스트 코드를 수행하지 않고 합치다 보니 항상 더 큰 문제점이 발생했다.

 

이러한 문제점을 예방하기 위해 Git ACTION을 통해 PR, PUSH가 되는 경우 테스트 코드가 항상 실행되게 만들었다.

 

그러한 Action을 만들기 위해서 습득한 지식을 작성하고, Git Action을 작성할  필요가 있는 분들에게 도움이 되면 좋겠다.

기본문법

1. 들여쓰기

들여쓰기 문법으로는 두 칸, 네 칸 들여쓰기를 지원한다.

#두 칸
Git-Action:
  name: Run-TestCode
  jobs:
    run: python -m unititest test_code.py
    
 #네 칸
Git-Action:
    name: Run-TestCode
    jobs:
        run: python -m unititest test_code.py

 

2. 데이터 정의

데이터는 key: value 형식으로 지정된다.

주의할 점은 key:(공백)value사이에 반드시 빈칸이 필요합니다.

Git-Action:
  name(key): Run-TestCode(value)
  jobs:
    run(key): python -m unititest test_code.py(value)

3. 배열 정의

배열은 '-'로 표시됩니다.

Git-Action:
  name: Run-TestCode
  jobs:
    - name: Run test_code.py
    - name: if fail then send sms

4. 참/거짓 표현

참/ 거짓은 true, false, yes, no를 지원합니다/.

study_hard: yes
give_up: no
hello: true
world: true
manual: false

5. 줄 바꿈

key : command 'l'   지시어는 줄을 바꾸라는 명령어입니다.

Git-Action:
  name: Run-TestCode
  jobs:
    - name: Run test_code.py
      run: |
      	python3 setup.py
	python3 -m unittest test.py
    - name: if fail then send sms

 

 

 

참고

yaml 문법 형식을 검사할 수 있습니다.

https://www.yamllint.com/