Github 작업으로 heroku 검토 앱 삭제

Heroku review apps은 Seasoned에서 작업 흐름의 매우 중요한 부분입니다. SPA + API 스택을 생성하는 데 사용하는 방법을 만들었기 때문에 많이 사용합니다.

예전에는 PR마다 자동으로 리뷰 앱을 만들었습니다. 그러나이 글을 쓰는 시점에서 Heroku는 프리 티어를 중단하려고합니다. 따라서 우리는 언제 리뷰 앱을 만들고 폐기해야 하는지에 대해 더 의식할 필요가 있습니다.

Heroku 대시보드를 통해 수동으로 생성할 수 있으므로 생성을 자동화하기 전에 PR이 닫힐 때 삭제되는지 확인하는 방법을 찾아봅시다.

Github marketplace에는 전체 검토 앱 워크플로를 처리하는 것처럼 보이는 작업이 있지만 모두 더 많은 작업을 수행하고 대부분은 서로 포크입니다. 지금은 삭제 프로세스만 처리하고 수동으로 수행하는 것을 선호했습니다.

어떻게

이를 위해서는 HerokuPlatform API가 필요합니다. 두 개의 API 호출이면 충분합니다.

이름에서 앱 ID 찾기

ID에서 삭제

앱 이름을 알 수 있도록 예측 가능한 URL 패턴 옵션을 사용한다는 점을 언급할 가치가 있습니다.

1: 앱 이름 얻기

GET /apps/{app_id_or_name}/review-app
전체 컬 명령:

curl -n https://api.heroku.com/apps/$APP_NAME/review-app \
  -H "Accept: application/vnd.heroku+json; version=3" \
  -H "Authorization: Bearer <heroku-api-key")

이것은 큰 JSON을 반환합니다. jq을 사용하여 구문 분석해 보겠습니다. 이미 Github 실행기preinstalled software의 일부이므로 액션 내부에 설치할 필요가 없습니다.

curl -n https://api.heroku.com/apps/$APP_NAME/review-app \
  -H "Accept: application/vnd.heroku+json; version=3" \
  -H "Authorization: Bearer <heroku-api-key>" | jq '.id'

"<app-id>"

그것은 우리에게 앱 ID를 줄 것입니다

2: 앱 삭제

남은 것은 삭제하는 것뿐입니다.DELETE /review-apps/{review_app_id}
컬 포함:

curl -n -X DELETE https://api.heroku.com/review-apps/<app-id>" \
 -H "Content-Type: application/json" \
 -H "Accept: application/vnd.heroku+json; version=3" \ 
 -H "Authorization: Bearer <heroku-api-key>"

Github 작업으로 변환

이제 Github Action 내에서 작업을 수행해야 합니다. Heroku JS 클라이언트를 사용하여 작업을 수행할 수 있지만 이는 전체 Node Github 작업을 생성하는 것을 의미하며 이 사용 사례에는 과도하게 보입니다.

코드를 더 쉽게 읽을 수 있도록 변수를 사용했고, 큰 명령 목록 대신 두 개의 잘 정의된 단계가 있는 단계 출력을 사용했습니다.
워크플로 트리거는 병합된 PR과 닫힌 PR 모두에 대해 실행되므로 "풀 요청 닫힘"일 수 있습니다.

지금까지 우리는:

# .github/workflows/destroy-review-app.yml
name: Destroy review app
on:
  pull_request:
    types: [closed]

env:
  app-name: <predictable-url-pattern>

jobs:
  heroku-review-application:
    name: Destroy Heroku review app
    runs-on: ubuntu-latest
    steps:
      - name: Get review app id
        id: get-id
        run: |
          RESPONSE=$(curl -n https://api.heroku.com/apps/${{ env.app-name }}-pr-${{ github.event.number }}/review-app -H "Accept: application/vnd.heroku+json; version=3" -H "Authorization: Bearer ${{ secrets.HEROKU_API_KEY }}")
          APP_ID=$(echo $RESPONSE | jq -r '.id')
          echo "::set-output name=app-id::$APP_ID"

      - name: Destroy app
        id: destroy-app
        run: |
          APP_ID=${{ steps.get-id.outputs.app-id }}
          echo "Using id ${{ steps.get-id.outputs.app-id }}"
          RESPONSE=$(curl -n -X DELETE https://api.heroku.com/review-apps/"$APP_ID" -H "Content-Type: application/json" -H "Accept: application/vnd.heroku+json; version=3" -H "Authorization: Bearer ${{ secrets.HEROKU_API_KEY }}")

-r 명령의 jq 플래그에 유의하십시오. 값에서 큰따옴표를 제거하여 나중에 사용하기 더 깔끔하게 만듭니다.

이 조치는 행복한 길을 위해 작동합니다. 이제 처리해야 할 두 가지 엣지 케이스가 있습니다.

오류 시 실패

오류가 발생한 경우 전체 응답을 인쇄하는 실패한 작업이 있는 것으로 충분합니다.
삭제 끝점의 JSON 응답에는 작동 여부를 확인하는 데 사용할 수 있는 status: "deleting" 속성이 있습니다.

STATUS=$(echo "$RESPONSE" | jq -r '.status')
if [ "$STATUS" = "deleting" ]; then
  echo "App deleted"
else
  echo "Error deleting app"
  echo "$RESPONSE"
  exit 1
fi

찾지 못한 경우 일찍 종료

모든 PR에 리뷰 앱이 있는 것은 아니며 그렇지 않은 모든 PR에 대해 실패한 작업을 원하지 않습니다! 그래서 앱이 존재하지 않는 경우 일찍 종료하는 조건을 추가해 보겠습니다.

if [ "$APP_ID" = "not_found" ]; then
  echo "App not found."
  exit 0
fi

작업 완료

짜잔! 여기에 우리의 완전한 조치가 있습니다.
특징:

PR 종료 시 실행

리뷰 앱이 있는 경우 삭제합니다

.

존재하지 않는 경우 성공적으로 종료합니다

.

앱을 찾았지만 삭제할 수 없는 경우 실패함

# .github/workflows/destroy-review-app.yml
name: Destroy review app
on:
  pull_request:
    types: [closed]

env:
  app-name: <predictable-url-pattern>

jobs:
  heroku-review-application:
    name: Destroy Heroku review app
    runs-on: ubuntu-latest
    steps:
      - name: Get review app id
        id: get-id
        run: |
          RESPONSE=$(curl -n https://api.heroku.com/apps/${{ env.app-name }}-pr-${{ github.event.number }}/review-app -H "Accept: application/vnd.heroku+json; version=3" -H "Authorization: Bearer ${{ secrets.HEROKU_API_KEY }}")
          APP_ID=$(echo $RESPONSE | jq -r '.id')
          echo "::set-output name=app-id::$APP_ID"

      - name: Destroy app
        id: destroy-app
        run: |
          APP_ID=${{ steps.get-id.outputs.app-id }}
          if [ "$APP_ID" = "not_found" ]; then
            echo "App not found."
            exit 0
          fi
          echo "Using id ${{ steps.get-id.outputs.app-id }}"
          RESPONSE=$(curl -n -X DELETE https://api.heroku.com/review-apps/"$APP_ID" -H "Content-Type: application/json" -H "Accept: application/vnd.heroku+json; version=3" -H "Authorization: Bearer ${{ secrets.HEROKU_API_KEY }}")
          STATUS=$(echo "$RESPONSE" | jq -r '.status')
          if [ "$STATUS" = "deleting" ]; then
            echo "App deleted"
          else
            echo "Error deleting app"
            echo "$RESPONSE"
            exit 1
          fi