[Android] Github Action을 이용하여 apk 파일 Slack으로 내보내기

+) 2021.05.23 

apk 추출 후 설치시 '애플리케이션이 설치되지 않았습니다' 오류가 있었습니다. 

'./gradlew assembleRelease' 가 아닌 Debug apk로 './gradlew assembleDebug' github action 코드를 수정하면 됩니다 !

(./gradlew assembleDebug' 시 apk 명도 확인 후 수정해야함!)

 

Github CI/CD를 간단하게 도와주는 Github Action을 이용하여 apk파일을 slack으로 추출하는 방법에 대해 적어보도록 할게요 : )

 

Github Action이란?!

Automate, customize, and execute your software development workflows right in your repository with GitHub Actions. You can discover, create, and share actions to perform any job you'd like, including CI

깃허브 자체에서 원하는 작업들을 지정하고, 설정하여 작업 workflow를 자동으로 실행시키는 것을 의미합니다.

Github Action을 통해 CI/CD 워크 플로우를 만들 수 있습니다!

 

 

슬랙 앱 만들기

Slack 채널이 있다는 전제하에 먼저 워크 플로우 만들기 전 추출한 apk를 슬랙에 보내주는 슬랙 앱을 만들어보도록 하겠습니다.

아래 페이지에서 슬랙 앱을 만들 수 있습니다!

Slack API: Applications | Slack

아래 페이지 들어가 Create New App을 클릭해주세요!

 

 

원하는 앱 이름과 슬랙 채널을 선택해주세요!

 

슬랙 앱 권한 설정 및 Bot Token 발급 받기 

apk 파일을 슬랙에 보내려면 write의 권한이 필요합니다!

Features -> OAuth&Permissions 탭에 들어가 아래로 스크롤 후, Scopes 에서 Bot Token Scopes에 files:write 권한을 추가해주세요!

 

 

제대로 추가하시면 아래 사진과 같이 추가가 됩니다!

 

그 다음 Bot의 Token을 발급 받기 위해 다시 위로 스크롤하여 Install to Workspace 를 눌러 줍니다 : ) 

클릭 하면 아래와 같은 창이 뜨는데 이때, 허용을 눌러주세요!

 

허용을 누르시면 Bot User OAuth Token이 생성 됩니다 !!

이 값은 github secrets 에 등록이 필요한 값 중 하나 입니다!

 

Webhooks Token 발급 받기

슬랙에 생성한 app이 메세지를 보내려면 Activate Incoming Webhooks가 ON 상태가 되어야합니다.

Features -> IncomingWebhooks 페이지를 누르면 초기에는 Off 상태로 되어 있습니다.

On으로 바꿔주세요!

 

On으로 바꾸게 되면 상단에 경고창이 뜨게 됩니다! 경고창에 reinstall your app을 눌러주세요!!

 

reinstall your app을 누르게 되면 아래에 채널을 추가할 수 있습니다 ! 

원하는 채널을 선택 후, 허용을 누르고 슬랙 해당 채널에 들어가보면, 아래와 같이 채널에 apk_deploy가 추가 된 것을 알 수 있습니다!!

스크롤 하면, 아래에 WebhookUrl 값이 있습니다. 이 값 또한, github secrets에 추가해야될 값입니다 : ) 

 

슬랙에 apk_deploy 연결하기

위에서 추가는 되었지만 연결이 된 상태는 아닙니다. 꼭! apk를 보내는 작업을 하시려면 apk_deploy와 슬랙 연결이 필요합니다.

이 작업을 하지 않고 그냥 넘어가시면 뒤에 github action 코드에서 apk를 슬랙에 보낼때 channel not in 에러가 발생합니다!!

 

슬랙 해당 워크스페이스에 들어가면 아래 앱 이라는 카테고리가 있습니다.

앱 추가를 눌러 주세요 !!

앱 추가를 누르시면, 앱을 검색하실 수 있습니다. 아까 위에서 만들어준 앱 이름인 apk_deploy를 검색하여, 추가해주세요!

아래와 같이 추가된 것을 알 수 있습니다 : )

 

apk_deploy를 선택한 뒤 원하는 슬랙 채널을 추가해주세요!

추가 후, 해당 채널에 들어가보면 아래와 같은 메세지를 볼 수 있습니다.

 

 

슬랙에 apk를 전달하는 app을 생성후 연결하는 모든 과정은 끝났습니다!!

이제 github action을 만들어 보도록 하겠습니다!!

 

 

Github Action Secret 값 추가하기

Github Actions를 설정할 레포지토리로 이동해주세요!

이동후, Settings -> Secrets 에 New repository secret을 추가하여 원하는 이름으로 위에서 생성한 값을 추가해주시면 됩니다 !!

SLACK_CHANNEL_DEPOLY : 해당 채널 명 또는 채널 id 값

저는 위에서 apk_deploy 앱을 연결한 채널명이 apk 이므로 apk를 넣어주었습니다!

SLACK_READ_WRITE_TOKEN : 위에서 만든 Bot의 토큰 값

SLACK_WEBHOOK_URL : 위에서 만들어준 WebHook Url 주소 값

 

Github Action 코드 작성해주기

이제 진짜 마지막 단계인 Github actions를 만들어주면 끝입니다!

Actions -> New workflow를 통해 github actions를 만들어 apk 를 추출하고, slack에 보내는 workflow를 작성해 보도록 하겠습니다.

아래와 같은 템플릿으로 workflows 코드가 미리 작성되어 있습니다. 코드를 수정해보도록 하겠습니다.

 

name : 해당 github action 이름

on:
  # Trigger the workflow on push or pull request,
  # but only for the main branch
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

push 또는 pull_request에 branch 명을 추가하여 해당 branch명에서 push, pull_request가 발생했을 때 작성한 github action workflow를 실행할 수 있도록 설정할 수 있습니다!

 

steps: 원하는 작업 (순차적으로 작성)

 

 

- Java JDK 설치

 - name: Set up JDK 1.8
      uses: actions/setup-java@v1
      with:
       java-version: 1.8

- 현재 날짜 구하기

 - name: Get current date
      id: date
      run: echo "::set-output name=date::$(date +'%Y-%m-%d')"

- Build 하기

  - name: Build APK
      run: bash ./gradlew assembleRelease --stacktrace

 

- apk 파일 slack에 전달하기

아래 라이브러리를 활용하여 apk를 추출하고 slack에 보내는 작업을 진행할 것입니다 : )

MeilCli/slack-upload-file

 - run: './gradlew assembleRelease'
    - uses: MeilCli/slack-upload-file@v1
      with:
        slack_token: ${{ secrets.SLACK_READ_WRITE_TOKEN }}
        channels: ${{ secrets.SLACK_CHANNEL_DEPLOY }}
        file_path: 'app/build/outputs/apk/release/app-release-unsigned.apk'
        file_name: 'app-release-unsigned.apk'
        file_type: 'apk'
        initial_comment: '${{ github.ref }} 테스트 앱 슬랙 배포 성공'

slack_token : secrets파일로 만들어준 Bot Token값 넣어주기

channels : 채널명 or 채널 id값

file_path : 빌드후 생성되는 apk 값 경로

file_name : 해당 파일 명

file_type : apk

initial_comment : 원하는 commet 메세지 

 

file_path, file_name 알아보기

file_path와 file_name은 터미널에 들어가 해당 Android Project 파일 명으로 이동하여 

./gradlew assembleRelease를 실행하여 생기는 app/build/outputs/apk/realease에 들어가보면 알 수 있습니다.

apk 명이 다 다를 수 있기 때문에 꼭 확인해주세요!!

 

- apk artifact 업로드 하기

    - name: 테스트용 apk artifact 업로드
      uses: actions/upload-artifact@v2
      with:
        name: app-release-unsigned.apk
        path: app/build/outputs/apk/release/app-release-unsigned.apk
        

- slack에 message 전송하기

        
    - name: action-slack
      uses: 8398a7/action-slack@v3.8.0
      with:
        status: ${{ job.status }}
        author_name: 빌드 알림
      env:
         SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}

 

 

github actions 전체 코드

# This workflow will build a Java project with Gradle
# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-gradle

name: Android CD

on:
  push:
    branches: master
    
  pull_request:
    branches: master
    
jobs:
  build:
    runs-on: ubuntu-16.04
    steps:
    - uses: actions/checkout@v1
    - name: Set up JDK 1.8
      uses: actions/setup-java@v1
      with:
       java-version: 1.8
       
    - name: Get current date
      id: date
      run: echo "::set-output name=date::$(date +'%Y-%m-%d')"
     
     
    - name: Build APK
      run: bash ./gradlew assembleRelease --stacktrace
     
     
    - run: './gradlew assembleRelease'
    - uses: MeilCli/slack-upload-file@v1
      with:
        slack_token: ${{ secrets.SLACK_READ_WRITE_TOKEN }}
        channels: ${{ secrets.SLACK_CHANNEL_DEPLOY }}
        file_path: 'app/build/outputs/apk/release/app-release-unsigned.apk'
        file_name: 'app-release-unsigned.apk'
        file_type: 'apk'
        initial_comment: '${{ github.ref }} 테스트 앱 슬랙 배포 성공'

       
    - name: 테스트용 apk artifact 업로드
      uses: actions/upload-artifact@v2
      with:
        name: app-release-unsigned.apk
        path: app/build/outputs/apk/release/app-release-unsigned.apk

 

 

 

 

위와 같이 github actions 코드를 수정하여 추가해준뒤, push나 pull request가 발생하면 아래와 같이 해당 github actions workflow 작업을 진행하는 것을 알 수 있습니다 !!

 

 

실행 뒤, 해당 github actions workflow가 성공하면, 아래와 같이 슬랙에 apk가 자동 배포되어 전달되어집니다 !!!

 

 

Github actions에 대해 알아보았습니다.

잘 이용하면 다양한 CI도 workflows 에 추가할 수 있는 아주 강력한 자동화 도구인 것을 알 수 있습니다 !

간단하게 apk를 자동 배포 해보세요 !! 읽어주셔서 감사합니다 : )

 

 

참고 자료

 

Github Actions 달기 (Slack)

Github Action으로 APK 자동배포하기 - To infinity and beyond