Github Ops 로 Mono Repo 배포를 더욱 쉽게

name: on-deploy-comment on: issue_comment: types: [created] permissions: pull-requests: write deployments: write contents: write checks: read statuses: read jobs: trigger: if: ${{ github.event.issue.pull_request }} # only run on pull request comments runs-on: self-hosted steps: - uses: github/branch-deploy@v9.8.1 id: branch-deploy with: environment: componentA-dev # .deploy 만 입력했을때 배포되는 환경 environment_targets: componentA-dev,componentB-dev,componentA-prod,component-B-prod # 배포 가능한 환경을 열거 해 줍니다. production_environments: componentA-prod,component-B-prod - uses: ./.github/action/deploy-componentA if: steps.branch-deploy.outputs.environment == 'componentA-prod' with: environment: prod - uses: ./.github/action/deploy-componentB if: steps.branch-deploy.outputs.environment == 'componentB-prod' with: environment: prod ...

name: Unlock On Merge on: pull_request: types: [closed] permissions: contents: write jobs: unlock-on-merge: runs-on: ubuntu-latest # Gate this job to only run when the pull request is merged (not closed) # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#running-your-pull_request-workflow-when-a-pull-request-merges if: github.event.pull_request.merged == true steps: - name: unlock on merge uses: github/branch-deploy@vX.X.X id: unlock-on-merge with: unlock_on_merge_mode: "true" # <-- indicates that this is the "Unlock on Merge Mode" workflow

jobs: trigger: if: ${{ github.event.issue.pull_request }} # only run on pull request comments runs-on: self-hosted outputs: continue: ${{ steps.branch-deploy.outputs.continue }} noop: ${{ steps.branch-deploy.outputs.noop }} environment: ${{ steps.branch-deploy.outputs.environment }} steps: - uses: github/branch-deploy@v9.8.1 id: branch-deploy with: environment: componentA-dev environment_targets: componentA-dev,componentB-dev,componentA-prod,component-B-prod deploy: if: ${{ needs.trigger.outputs.continue == 'true' && needs.trigger.outputs.noop != 'true' }} needs: ["trigger"] environment: ${{ needs.trigger.outputs.environment }} steps: - uses: ./.github/action/deploy with: target: ${{var.TARGET}} environment: ${{var.ENVIRONMENT}}

jobs: trigger: if: ${{ github.event.issue.pull_request }} # only run on pull request comments runs-on: self-hosted outputs: continue: ${{ steps.branch-deploy.outputs.continue }} noop: ${{ steps.branch-deploy.outputs.noop }} environment: ${{ steps.branch-deploy.outputs.environment }} ... steps: - uses: github/branch-deploy@v9.8.1 id: branch-deploy with: environment: componentA-dev environment_targets: componentA-dev,componentB-dev,componentA-prod,component-B-prod deploy: if: ${{ needs.trigger.outputs.continue == 'true' && needs.trigger.outputs.noop != 'true' }} needs: ["trigger"] runs-on: self-hosted environment: ${{ needs.trigger.outputs.environment }} steps: - uses: ./.github/action/deploy with: target: ${{var.TARGET}} environment: ${{var.ENVIRONMENT}} result: needs: [trigger, deploy] if: ${{ always() && needs.trigger.outputs.continue == 'true' }} runs-on: self-hosted steps: - ... # example에서 복사,붙여넣기 하면 됩니다.

name: '[ComponentA] Deploy On Merge' on: push: branches: - main paths: - 'cmd/component-a/**' - 'pkg/**' - 'go.mod' - 'go.sum' --- name: '[ComponentB] Deploy On Merge' on: push: branches: - main paths: - 'cmd/component-b/**' - 'pkg/pkg-only-b-using/**' - 'go.mod' - 'go.sum'

# .github/labeler.yml deploy/component-a: - changed-files: - any-glob-to-any-file: - 'cmd/component-a/**' - 'pkg/**' - 'go.mod' - 'go.sum' deploy/component-b: - changed-files: - any-glob-to-any-file: - 'cmd/component-b/**' - 'pkg/pkg-only-b-using/**' - 'go.mod' - 'go.sum'

# .github/workflows/labler name: "PR Labeler" on: - pull_request jobs: labeler: permissions: contents: read pull-requests: write runs-on: ubuntu-latest steps: - uses: actions/labeler@v5

name: check-deploy-requirement on: pull_request: types: [ opened, synchronize, unlabeled ] permissions: contents: read pull-requests: write deployments: write env: GH_TOKEN: ${{ github.token }} jobs: check-deploy-requirement: runs-on: self-hosted steps: # PR의 label로 부터 배포가 필요한 환경목록을 불러옵니다 - name: check label id: check-label run: | target_pr="${{ github.event.pull_request.number }}" required_env="" while read label; do env=$(echo $label | cut -d/ -f2) if [[ -z $required_env ]]; then required_env=$env else required_env="$required_env,$env" fi done < <(gh pr view $target_pr --repo ${{github.repository}} --json labels -q '.labels[] | .name' | grep "^deploy/") echo "required :: $required_env" echo "required_env=$required_env" >> $GITHUB_OUTPUT # deployment 상태를 체크합니다 - name: check deployment id: check-deploy-requirement run: | result_comment="" failed=false target_sha="${{ github.event.pull_request.head.sha }}" deployed_env=$(gh api "repos/${{github.repository}}/deployments?sha=$target_sha" | jq -r '.[] | .environment') for env in $(echo "${{ steps.check-label.outputs.required_env }}" | tr ',' '\n'); do if [[ -z $(echo $deployed_env | grep $env) ]]; then echo "$env not deployed" result_comment="$result_comment- \`${env}\` not deployed \n" failed=true else echo "$env :white_check_mark: deployed" result_comment="$result_comment- \`${env}\` :white_check_mark: deployed\n" fi done echo "result_comment<<EOF" >> $GITHUB_OUTPUT echo -e $result_comment >> $GITHUB_OUTPUT echo "EOF" >> $GITHUB_OUTPUT if [[ $failed == true ]]; then exit 1 fi echo "all required env deployed" # required env 가 배포 되었는지 댓글로 알려줍니다. - name: comment on the pull request if : always() uses: hasura/comment-progress@v2.3.0 with: github-token: ${{ secrets.GITHUB_TOKEN }} repository: ${{ github.repository }} number: ${{ steps.get-pr-number.outputs.pr-number }} id: check-deploy-requirement recreate: true message: | ## Deploy Requirement Check :white_check_mark: required env : ${{ steps.check-label.outputs.required_env || 'none' }} ${{ steps.check-deploy-requirement.outputs.result_comment }}

- name: check deployment id: check-deploy-requirement run: | ... if [[ $failed == true ]]; then exit 0 fi echo "all required env deployed" # deployment를 deployment-check환경에 대해 생성합니다. deploy_id=$(gh api --method POST repos/${{github.repository}}/deployments -q '.id' \ -f ref=$target_sha \ -f environment=deployment-check \ -F auto_merge=false \ -F 'required_contexts[]' \ -f description="all required env deployed" ) # deployment의 상태를 성공으로 변경합니다. gh api --method POST repos/${{github.repository}}/deployments/$deploy_id/statuses \ -f state=success \ -f description="all required env deployed"

... jobs: release: steps: ... # 태그명을 준비합니다. - name: tag-prepare id: tag-prepare # todo check if image exists, add idx run: | base_tag=v$(date +'%Y%m%d%H') idx=0 tag_name=$base_tag while git rev-parse "${{ env.TARGET_CODE }}_$tag_name" >/dev/null 2>&1; do # 중복되는 태그가 있을 경우 .idx를 붙여서 새로운 태그 이름 생성 idx=$((idx + 1)) tag_name="${base_tag}.${idx}" done echo "dkr-release-version=$tag_name" >> $GITHUB_OUTPUT echo "gh-release-version=${{ env.TARGET_CODE }}_$tag_name" >> $GITHUB_OUTPUT - name: build-and-push id: build-and-push uses: docker/build-push-action@v2 with: push: true tags: ${{ env.ECR_REPOSITORY }}:${{ steps.tag-prepare.outputs.dkr-release-version }} ... - name: make release id: make-release env: GH_TOKEN: ${{ github.token }} run: | # release body를 PR body를 이용해 작성 gh pr view ${{inputs.ref}} --json title,body -t '# {{.title}} {{.body}} ' | sed '/<!--- checklist --->/,$d' >> note.md echo '---' >> note.md echo "* \`${{env.ECR_REPOSITORY}}:${{steps.tag-prepare.outputs.dkr-release-version }}\`" >> note.md # release를 prerelase로 생성 gh release create ${{ steps.tag-prepare.outputs.gh-release-version }} \ --title "${{ steps.tag-prepare.outputs.gh-release-version }}" \ --notes-file note.md \ --target "${{ needs.trigger.outputs.sha }}" \ --prerelease - name: Deploy to ArgoCD uses: ./.github/actions/argocd-deploy id: argocd_deploy with: image-tag: ${{ steps.tag-prepare.outputs.dkr-release-version }} argocd-application: ${{ env.ARGOCD_APPLICATION }}

on: pull_request: types: [closed] permissions: contents: write jobs: release-latest: runs-on: self-hosted-arm64-nano env: GH_TOKEN: ${{ github.token }} steps: # 모든 git 히스토리를 가져옵니다. - uses: actions/checkout@v4 with: ref: ${{ github.event.pull_request.head.sha }} fetch-depth: 0 - name: release latest if: github.event.pull_request.merged == true id: release-latest run: | # 마지막 커밋에 있는 tag를 찾아내 release를 수정해 줍니다. git tag --contains ${{ github.event.pull_request.head.sha }} | while read tag; do echo "release $tag as latest" gh release edit \ --prerelease=false \ --draft=false \ $tag done - name: remove unreleased id: remove-unreleased run: | # PR에 남아있는 prerelease들을 모두 제거해줍니다. first_sha=$(git rev-list ${{github.event.pull_request.base.sha}}..${{github.event.pull_request.head.sha}} --reverse | head -n 1) git tag --contains $first_sha | while read tag; do if [[ -n $(gh release view $tag --json isDraft,isPrerelease,name -q'select(.isDraft or .isPrerelease)') ]]; then echo "delete $tag" gh release delete --cleanup-tag -y $tag || true fi done

name: Manual Deploy on: workflow_dispatch: inputs: environment: description: environment name to deploy to required: true type: environment environment_confirm: description: "[confirm] environment name to deploy to" required: true type: string jobs: deploy: env: TARGET_CODE: ${{ vars.TARGET_CODE }} runs-on: self-hosted environment: ${{ inputs.environment }} steps: # 실수를 방지하기 위해 confirm 절차를 추가하였습니다. - name: Check Environment Input if: github.event_name == 'workflow_dispatch' run: | if [[ '${{ inputs.environment }}' != '${{ inputs.environment_confirm }}' ]]; then exit 1 fi # release로 실행된게 맞는지확인하고, release tag를 output으로 저장합니다. - id: tag name: tag check run: | if [[ "$GITHUB_REF" == "refs/tags/"* ]]; then tag="$(echo $GITHUB_REF | sed 's/refs\/tags\///')" else tag=${{ inputs.tag }} fi if [[ $tag == "${{ env.TARGET_CODE }}_"* ]]; then echo "tag=$tag" >> $GITHUB_OUTPUT echo "docker_tag=$(echo $tag | sed 's/${{ env.TARGET_CODE }}_//' )" >> $GITHUB_OUTPUT else echo "tag=$tag is not a valid tag for ${{ env.TARGET_CODE }}" exit 1 fi # 알아낸 tag를 기준으로 배포를 시작합니다. - name: manual deploy uses: ./.github/actions/manual-deploy with: tag: ${{ steps.tag.outputs.docker_tag }} environment: ${{ inputs.environment }}

gh workflow run <workflow name | workflow id> \ --repo <owner>/<reponame> \ -r <tag-name> \ -f environment=<environment> \ -f environment_confirm=<environment>