[GitHub] PR 자동으로 만들기
나는 혼자 개발할 때가 많다.
그럴때마다 PR을 만들고.. 셀프 리뷰하고.. 머지하는 작업은 사실 쉽지않다.
그렇다고 PR을 안 만들기엔 이력 관리가 잘 안 된다.
일단 PR이라도 자동으로 만들어봐야겠다.
GitHub에 프로젝트가 있고, Jira와 연동되어있다고 가정합니다.
Jira를 사용하지 않더라도, 관련 내용은 빼고 보셔도 무방합니다.
GitHub Actions
GitHub을 사용하고 있으니, 추가적인 설치가 필요없는 GitHub Actions를 사용한다.
깃헙짱..
workflow
GitHub Actions에서는 하나의 자동화된 전체 프로세스를 workflow라고 부른다.
예를들어 어떠한 이벤트(push, pr 등)가 발생하면 주어진 일(PR 생성 등)을 실행하는 일련의 프로세스를 뜻한다.
workflow는 yml 파일로 작성한다.
크게 job 단위로 작업을 구분하고, 각 job은 step 단위를 통해 단계별로 실행되도록 한다.
job은 여러 개 있을 수 있으며, 여러 job이 독립적으로 실행될 수도 있고, 다른 job끼리 의존되게 실행될 수도 있다.
자세한 내용은 Github Action의 코어 개념을 참고하면 좋을 것 같다.ㅎㅎ
자동 PR 만들기
내가 사용하고 있는 자동 PR workflow를 공유한다.
프로젝트 root에 .github/workflows/auto-pr.yml에 만든다.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
name: Auto PR
permissions:
contents: read
pull-requests: write
issues: write
on:
push:
branches:
- "feature/ITS-*"
jobs:
auto-pr:
runs-on: ubuntu-latest
steps:
- name: 체크아웃
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: 브랜치명에서 지라 이슈키 추출
run: |
branch="${GITHUB_REF#refs/heads/}"
echo "branch=$branch" >> $GITHUB_ENV
if [[ "$branch" =~ ([A-Z]+-[0-9]+) ]]; then
echo "issue_key=${BASH_REMATCH[1]}" >> $GITHUB_ENV
else
echo "issue_key=" >> $GITHUB_ENV
fi
- name: 지라 이슈 제목 가져오기
if: env.issue_key != ''
run: |
jira_response=$(curl -s -u "${{ secrets.JIRA_EMAIL }}:${{ secrets.JIRA_API_TOKEN }}" \
-H "Accept: application/json" \
"https://gingaminga.atlassian.net/rest/api/3/issue/${{ env.issue_key }}")
title=$(echo "$jira_response" | jq -r '.fields.summary')
echo "jira_title=$title" >> $GITHUB_ENV
- name: PR 생성하기
uses: thomaseizinger/create-pull-request@master
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
head: ${{ github.ref_name }}
base: develop
title: "[${{ env.issue_key }}] ${{ env.jira_title }}"
body: |
자동 생성된 PR입니다.
- 지라이슈: [${{ env.issue_key }}](https://gingaminga.atlassian.net/browse/${{ env.issue_key }})
- name: PR에 Assignee 추가하기
uses: actions/github-script@v7
with:
script: |
const { repo, owner } = context.repo;
const prList = await github.rest.pulls.list({
owner,
repo,
head: `${owner}:${process.env.branch}`,
state: 'open'
});
if (prList.data.length > 0) {
const prNumber = prList.data[0].number;
// Assignee 추가
await github.rest.issues.addAssignees({
owner,
repo,
issue_number: prNumber,
assignees: [owner]
});
console.log(`Assignee를 ${owner}로 추가 완료 :)`);
} else {
console.log("PR을 찾지 못했습니다. :(");
}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
branch: ${{ github.ref_name }}
흐름은 다음과 같다.
- feature/[이슈키] 브랜치에서 push 이벤트 발생 시 workflow 동작
- 브랜치명에서 이슈키 추출
- 지라 이슈 제목 가져오기 (추후 PR의 제목이 될 것)
- PR 생성
- 생성된 PR에
assignee추가
GITHUB_TOKEN
workflow 내용 중간중간 secrets.GITHUB_TOKEN을 사용한다.
PR을 만들고 수정하는 작업은 아무나 할 수 없기 때문에, 미리 토큰을 만들고 사용할 수 있도록 한다.
개인 토큰 만들기에서 만들 수 있다.
만들 때 하단에 Permissions가 있는데, 그 중 Repository Permissions에서 몇 가지 선택을 해야한다.
레포지토리의 내용(commit, branch 등)을 읽을 권한을 준다.
PR에 관련된 내용(label, assignee 등)을 읽고 쓰는 권한을 준다.
그 후 생성을 하면 토큰이 만들어진다.
토큰값은 더 이상 확인이 안 되니 어딘가에 꼭 저장을 해둔다.
이제 레포지토리로 이동 후, Settings > Secret and variables > Actions에서 Repository secret에 토큰을 등록한다.
이름이 꼭 secret.GITHUB_TOKEN일 필요는 없다. 하지만 이름을 바꾸면 workflow에서도 바꿔줘야 한다는걸 잊지말자.
JIRA_EMAIL, JIRA_API_TOKEN
JIRA_EMAIL과 JIRA_API_TOKEN는 jira 이슈키를 통해 지라의 타이틀명을 가져오기 위해 사용한다.
JIRA_EMAIL은 jira 가입 시 등록한 이메일을 사용하면 된다.
JIRA_API_TOKEN은 jira에서 발급받아 사용하면 된다. 지라 토큰 생성하기에서 금방 만들 수 있다.
이 두 개 또한 Repository secret에 등록하면 끝이다.
PR 생성
이제 이 워크플로우를 commit & push 하면 자동으로 PR이 생성된다.
이제 생성해야하는 귀찮음이 사라졌다!!
이제 리뷰도 좀 자동으로 해주면 좋을텐데..