Github Actions 로 Android 팀의 효율성 극대화

Google I/O extended Android 2024 때 발표한 자료 입니다.

Transcript

1. 하동현 / @harada.ha Github Actions 로 Android 팀의 효율성 극대화
2. 성장하는 팀, 늘어나는 업무: Github Actions 도입 배경 Section 1
3. H사 2 ~ 3명 Section 1 # 소통의 용이함 # 자원 부족 # 단순한 관리
4. B사 5 ~ 8명 Section 1 # 소통의 복잡성 증가 # 복잡한 워크플로우 # 안정된 운영
5. K사 10명 Section 1 # 향상된 안정성 # 관리 오버헤드
6. K사 bitrise B사 Github Actions Section 1
7. Github Actions Section 1
8. Github Actions 개요
9. Github Actions Section 1 # CI / CD
10. Event Runner 1 Runner 2 Job 1 Job 2 Runner 1 Runner 2 Step 1 : Run action Step 2 : Run script Step 1 : Run action Section 1
11. pull_request, issue_comment, workflow_dispatch, … Events on : pull_request : types : [opened, synchronize] Section 1
12. Event Runner 1 Runner 2 Job 1 Job 2 Runner 1 Runner 2 Step 1 : Run action Step 2 : Run script Step 1 : Run action Section 1
13. Event Runner 1 Runner 2 Job 1 Job 2 Runner 1 Runner 2 Step 1 : Run action Step 2 : Run script Step 1 : Run action Section 1
14. Job 을 구성하는 작은 단계 Actions steps : # 체크아웃 액션: 저장소의 코드를 체크아웃 - - name : Check out Code uses : actions/checkout@v3 # 액션: 코드 컴파일 - name : Build the project run : ./gradlew assembleDebug Section 1
15. Event Runner 1 Runner 2 Job 1 Job 2 Runner 1 Runner 2 Step 1 : Run action Step 2 : Run script Step 1 : Run action Section 1
17. 효율적인 워크플로우 구축: Github Action 적용 사례 Section 2
18. Android PR Board Section 2
19. Android PR Board Section 2
20. - Ts : 수동으로 카드 하나를 생성하는 데 걸리는 시간 = 20초 - R : PR 당 리뷰어의 수 = 2명 - P : PR의 수 = 3개 - C : 총 생성해야 하는 카드의 수 = R×P = 6개 Total_s = C×Ts = 6×20 = 2분 PR 카드 생성 시간 Section 2 Section 2
21. PR 카드 생성 시간 Section 2 1일 기준 = 2분 × 5명 = 10분 근무 21일 기준 = 210분 = 3.5시간
22. GitHub Docs Section # Section 2
23. PR 카드 생성 자동화로 시간 절약 3.5H Save Section # Section 2
24. PR Review Workflow
25. PR Review Workflow Section 2 /review @notifier, @notifier
26. PR Review Workflow Section 2 set-reviewers
27. PR Review Workflow Section # Section 2 create-card
28. PR Review Workflow Section # PR Card Section 2 move-card
29. pr_comment prepare /review @notifier, @notifier pr_number pr_assignee pr_reviewers pr_data review-pr-card pr-review column_id find-card set-reviewers create-card move-card outputs
30. PR Comment
31. pr_comment prepare /review @notifier, @notifier pr_number pr_assignee pr_reviewers pr_data review-pr-card pr-review column_id find-card set-reviewers create-card move-card outputs
32. PR Comment Section 2 /review @notifier, @notifier
33. https://docs.github.com/ko/actions/using-workflows/events-that-trigger-workflows Events on : issue_comment : types : [created] Section 2 - created - edited - deleted
34. Jobs Section 2 jobs : pr_comment : if : github.event.issue.pull_request && startsWith(github.event.comment.body, '/review' ) steps : - name : Dispatch . . .
35. https://github.com/actions/github-script Actions steps : # PR comment 분석하여 리뷰어 추출 후, review-pr-card 워크 플로우 트리거 - - name : Dispatch uses : actions/github-script@v7 with : github-token : ${{ secrets.GITHUB_TOKEN }} script : | Section 1 Section 2
36. - name : dispatch uses : actions/github-script@v7 with : github-token : ${{ secrets.GITHUB_TOKEN }} script : | const[ , …reviewParameters] = '${{ github.event.comment.body }}'.trim().split(' ') . . . await github.rest.actions.createWorkflowDispatch({ . . .context.repo, workflow_id : 'action-pipelines-review-pr-card.yml', ref : context.ref, inputs : { pr_number: `${ context.issue.number }`, . . . } });
37. pr_comment prepare /review @notifier, @notifier pr_number pr_assignee pr_reviewers pr_data review-pr-card pr-automation column_id find-card set-reviewers create-card move-card outputs
38. PR Board Section # Section 2 Assignee Reviewer PR Data
39. - name : dispatch . . . with : script : | . . . await github.rest.actions.createWorkflowDispatch({ . . .context.repo, workflow_id : 'action-pipelines-review-pr-card.yml', ref : context.ref, inputs : { pr_number: `${ context.issue.number }`, pr_assignee: `${ commentUser }`, pr_reviewers = `${ notifiers.join() }` } });
40. Review PR Card
41. pr_comment prepare /review @notifier, @notifier pr_number pr_assignee pr_reviewers pr_data review-pr-card pr-review column_id find-card set-reviewers create-card move-card outputs
42. on : workflow_dispatch : inputs : pr_number : description : 'PR number' required : true default : ' ' pr_assignee : . . . pr_reviewers : . . . jobs : prepare : runs-on : [self-hosted, amd64, small, spot] steps : . . .
44. prepare pr_data review-pr-card pr-review column_id find-card set-reviewers create-card move-card pr_html_url pr_title outputs
45. PR Card Section # pr_title pr_html_url Section 2
46. prepare : steps : - name : get-pr-data uses : actions/github-script@v7 id : pr_data with : script : | . . . return pr_data - name : get-pr-url . . . script : | const prData = ${{ steps.pr_data.outputs.result }} return prData.html_url result-encoding : string
47. prepare : steps : - name : get-pr-data uses : actions/github-script@v7 id : pr_data with : script : | . . . return pr_data - name : get-pr-url . . . script : | const prData = ${{ steps.pr_data.outputs.result }} return prData.html_url result-encoding : string
48. prepare pr_data review-pr-card pr-review column_id find-card set-reviewers create-card move-card pr_assignee_column_id pr_reviewers_column_id outputs Section 2
49. PR Board Section # Section 2 pr_assignee_column_id pr_reviewers_column_id
50. prepare : steps : . . . - name : checkout uses : actions/checkout@v3 - name : pr-assignee-to-project-column-id run : chmod +x ./column.sh result=$(./column.sh "${{ github.event.inputs.pr_assignee }}") echo "result=${result}" >> $GITHUB_OUTPUT . . .
51. pr_comment prepare /review @notifier, @notifier pr_number pr_assignee pr_reviewers pr_data review-pr-card pr-review column_id find-card set-reviewers create-card move-card outputs
52. jobs : prepare : steps : - name : get-pr-data - name : get-pr-url . . . outputs : pr_html_url : ${{ steps.pr_html_url.outputs.result }} pr_title : ${{ steps.pr_title_url.outputs.result }} pr_assignee_column_id : ${{ steps.pr-assignee-to-project-column-id.outputs.result }} . . . pr-automation : . . .
53. pr_comment prepare /review @notifier, @notifier pr_number pr_assignee pr_reviewers pr_data review-pr-card pr-review column_id find-card set-reviewers create-card move-card outputs
54. jobs : prepare : steps : - name : get-pr-data - name : get-pr-url . . . pr-review : needs : [ prepare ] steps : - name : find-card - name : set-reviewers - name : create-card - name : move-card
55. jobs .<job_id> .needs Section # Section 2
56. pr_comment prepare /review @notifier, @notifier pr_number pr_assignee pr_reviewers pr_data review-pr-card pr-review column_id find-card set-reviewers create-card move-card outputs
57. Find Card Section # Section 2 기존에 카드가 존재 했을 경우
58. - name : find-card uses : actions/github-script@v7 id : find_card with : github-token : ${{ secrets.GITHUB_TOKEN }} script : | const { data: listCards } = await github.rest.projects.listCards({ column_id : columnId, }); . . . if (card) { return card.id } else { return 0 }
59. - name : find-card uses : actions/github-script@v7 id : find_card with : github-token : ${{ secrets.GITHUB_TOKEN }} script : | const { data: listCards } = await github.rest.projects.listCards({ column_id : colinmId, }); . . . if (card) { return card.id } else { return 0 }
60. pr_comment prepare /review @notifier, @notifier pr_number pr_assignee pr_reviewers pr_data review-pr-card pr-review column_id find-card set-reviewers create-card move-card outputs
61. - name : set-reviewers if : steps.find_card.outputs.result == 0 uses : actions/github-script@v7 with : github-token : ${{ secrets.GITHUB_TOKEN }} script : | const { data: requestedReviewers } = await github.rest.pulls.listRequestedReviewers({ column_id : colinmId, }); . . . if (requestedReviewers.users.length === 0) { await github.rest.pulls.requestReviewers({ . . . }} }
62. - name : set-reviewers if : steps.find_card.outputs.result == 0 uses : actions/github-script@v7 with : github-token : ${{ secrets.GITHUB_TOKEN }} script : | const { data: requestedReviewers } = await github.rest.pulls.listRequestedReviewers({ column_id : colinmId, }); . . . if (requestedReviewers.users.length === 0) { await github.rest.pulls.requestReviewers({ . . . }} }
63. PR Reviewers State Section 2 approved requested-reviewer
64. - name : set-reviewers if : steps.find_card.outputs.result == 0 uses : actions/github-script@v7 with : github-token : ${{ secrets.GITHUB_TOKEN }} script : | const { data: requestedReviewers } = await github.rest.pulls.listRequestedReviewers({ column_id : colinmId, }); . . . if (requestedReviewers.users.length === 0) { await github.rest.pulls.requestReviewers({ . . . }} }
65. pr_comment prepare /review @notifier, @notifier pr_number pr_assignee pr_reviewers pr_data review-pr-card pr-review column_id find-card set-reviewers create-card move-card outputs
66. pr_comment prepare /review @notifier, @notifier pr_number pr_assignee pr_reviewers pr_data review-pr-card pr-review column_id find-card set-reviewers create-card move-card outputs
67. PR Review Card Section # PR Card Section 2
68. 찾아온 위기: Projects Sunset
69. Projects (classic) sunset Section 2
70. PR Review Section 2 팀원들이 PR을 잘 볼 수 있는 방법 없을까?
71. GitHub Integration Section # Section 2
72. Slack Github Action Section # Section 2
73. pr_comment prepare /review @notifier, @notifier pr_number pr_assignee pr_reviewers pr_data pr-review github_username set-reviewers notify-reviewers send-dm-for- reviewer outputs notify-pr-reviewer pr_title pr_url pr_assignee pr_reviewer
74. pr_comment prepare /review @notifier, @notifier pr_number pr_assignee pr_reviewers pr_data pr-review github_username set-reviewers notify-reviewers send-dm-for- reviewer outputs notify-pr-reviewer pr_title pr_url pr_assignee pr_reviewer
75. - name : notify-reviewers uses : actions/github-script@v7 with : github-token : ${{ secrets.GITHUB_TOKEN }} script : | . . . for (const reviewer of selectedReviewers) { await github.rest.actions.createWorkflowDispatch({ . . . context.repo, workflow_id : 'action-pipelines-notify-pr-reviewer.yml', inputs: { . . . } } }
76. PR Reviewers Section 2 notify-pr-reviewer notify-pr-reviewer notify-pr-reviewer
77. pr_comment prepare /review @notifier, @notifier pr_number pr_assignee pr_reviewers pr_data pr-review github_username set-reviewers notify-reviewers send-dm-for- reviewer outputs notify-pr-reviewer pr_title pr_url pr_assignee pr_reviewer
78. - name : send-dm-for-reviewer uses : slackapi/slack-github-action@v1.26.0 env : SLACK_BOT_TOKEN : ${{ secrets.SLACK_ANDROID_PR_BOT_TOKEN }} with : channel-id : ${{ steps.pr_reviewer_slack_mention_token.outputs.result }} payload : | { "blocks" : [ { "type" : "header", "text" : { "type" : "plain_text", "text" : "PR 리뷰 부탁드립니다 :pray:", "emoji" : true } . . .
79. Slack API Your Apps Section # Section 2
80. Slack Bot Token Section # https://api.slack.com/tutorials/tracks/getting-a-token Section 2
81. Slack Bot Token Scopes Section # Section 2
82. GitHub Repository Settings Section # Section 2
83. - name : send-dm-for-reviewer uses : slackapi/slack-github-action@v1.26.0 env : SLACK_BOT_TOKEN : ${{ secrets.SLACK_ANDROID_PR_BOT_TOKEN }} with : channel-id : ${{ steps.pr_reviewer_slack_mention_token.outputs.result }} payload : | { "blocks" : [ { "type" : "header", "text" : { "type" : "plain_text", "text" : "PR 리뷰 부탁드립니다 :pray:", "emoji" : true } . . .
84. - name : send-dm-for-reviewer uses : slackapi/slack-github-action@v1.26.0 env : SLACK_BOT_TOKEN : ${{ secrets.SLACK_ANDROID_PR_BOT_TOKEN }} with : channel-id : ${{ steps.pr_reviewer_slack_mention_token.outputs.result }} payload : | { "blocks" : [ { "type" : "header", "text" : { "type" : "plain_text", "text" : "PR 리뷰 부탁드립니다 :pray:", "emoji" : true } . . .
85. Slack Channel-Id Section # Section 2
86. Slack Channel-Id Section # Section 2 https://api.slack.com/types/channel channel-id example: C1H9RESGL
87. Slack Channel-Id Section # Section 2
88. Slack Mention Section # Section 2 channel-id : C1H9RESGL mention : <@U0G9QF9C6>
89. - name : send-dm-for-reviewer uses : slackapi/slack-github-action@v1.26.0 env : SLACK_BOT_TOKEN : ${{ secrets.SLACK_ANDROID_PR_BOT_TOKEN }} with : channel-id : ${{ steps.pr_reviewer_slack_mention_token.outputs.result }} payload : | { "blocks" : [ { "type" : "header", "text" : { "type" : "plain_text", "text" : "PR 리뷰 부탁드립니다 :pray:", "emoji" : true } . . .
90. Slack Block Kit Builder Section # Section 2
91. Slack Block Kit Builder Section # Section 2
92. Slack Block Kit Builder Section # Section 2
93. - name : send-dm-for-reviewer uses : slackapi/slack-github-action@v1.26.0 env : SLACK_BOT_TOKEN : ${{ secrets.SLACK_ANDROID_PR_BOT_TOKEN }} with : channel-id : ${{ steps.pr_reviewer_slack_mention_token.outputs.result }} payload : | { "blocks" : [ { "type" : "header", "text" : { "type" : "plain_text", "text" : "PR 리뷰 부탁드립니다 :pray:", "emoji" : true } . . .
94. Android PR Bot Section # Section 2
95. PR Review Reminder
96. PR Review Reminder Section 2 Slack DM으로 PR 메시지가 오는데 자꾸 까먹네... PR을 잘 볼 수 있는 방법 없을까?
97. PR Review Reminder Section 2 매일 오후 1시에 슬랙 알람이 온다면.. D-day 라벨을 붙이면..
98. pr-remind find-open-pr get-slack-mention- token notify-pr-list-to-reviewer payload pr_reviewer prepare-slack-message send-dm-for- reviewer
99. on : schedule : # 평일 13시 실행 cron : '0 4 * * 1-5' workflow_dispatch : jobs : pr-remind : . . . steps : - name : find-open-pr - name : prepare-slack-message . . .
100. Slack Block Kit Builder Section # Section 2
101. pr-remind find-open-pr get-slack-mention- token notify-pr-list-to-reviewer payload pr_reviewer prepare-slack-message send-dm-for- reviewer
102. - name : find-open-pr . . . script : | const { data : pullRequests } = await github.rest.pulls.list({ . . . }); const filteredPullRequests = pullRequests.filter(pr => pr.requested_reviewers.length !=0 && !pr.draft ); return filteredPullRequests
103. - name : find-open-pr . . . script : | const { data : pullRequests } = await github.rest.pulls.list({ . . . }); const filteredPullRequests = pullRequests.filter(pr => pr.requested_reviewers.length !=0 && !pr.draft ); return filteredPullRequests
104. Error Section # Section 2
105. pr-remind find-open-pr get-slack-mention- token notify-pr-list-to-reviewer payload pr_reviewer prepare-slack-message send-dm-for- reviewer
106. - name : prepare-slack-message . . . script : | . . . const payload = { blocks : [ . . . ] } await github.rest.actions.createWorkflowDispatch({ . . . inputs : { payload : JSON.stringfy(payload), pr_reviewer : `${ reviewer }` } })
107. Slack Block Kit Builder Section # Section 2
108. - name : prepare-slack-message . . . script : | . . . const payload = { blocks : [ . . . ] } await github.rest.actions.createWorkflowDispatch({ . . . inputs : { payload : JSON.stringfy(payload), pr_reviewer : `${ reviewer }` } })
109. pr-remind find-open-pr get-slack-mention- token notify-pr-list-to-reviewer payload pr_reviewer prepare-slack-message send-dm-for- reviewer
110. pr-remind find-open-pr get-slack-mention- token notify-pr-list-to-reviewer payload pr_reviewer prepare-slack-message send-dm-for- reviewer
111. PR Reminder Section # Section 2
112. PR Review Reminder Section 2 Section 3
113. Github Actions, 그 이후 Section 3
114. Android Build Bot Section 2 Section 3
115. Android Build Bot Section 2 Section 3
116. PR Review Label Section 2 Section 3
117. Thank You 하동현 / @harada.ha Remember | ex-KakaoStyle