Github Action Workflow Uses

actions/setup-python

actions/setup-python@v5 - latest version (2024/01/03)

GitHub - actions/setup-python: Set up your GitHub Actions workflow with a specific version of Python

 

python-version (Optional) : python 버전 명시. (default: .python-version > pypy version)

• semver 버전 사용(유의적 버전 2.0.0 ) ex) 3.11.4
• 버전 입력시 유의 사항
  • 필요한 특정 버전의 Python 설치 시 버전 별 주요 변경 사항에 대해 상관 없을 경우 주, 부 버전 및 패치 버전 (예: 처럼 ):3.7.6, 3.7.5 기입
  • semver에 지정된 여러 유형의 범위 사용 (`>=3.9 <3.10`)
  • check-latest : 최신 버전 사용 (default: false)

 

workflow_dispatch 기능

워크플로우가 수동으로 트리거되도록 하려면 workflow_dispatch 이벤트를 구성해야한다.

on: workflow_dispatch

 

워크플로를 트리거하는 이벤트 - GitHub Docs

name: Action  # Use tags to trigger the action
on:
  workflow_dispatch:
    inputs:
      statement:
        description: Question
        required: true
        default: "\"How is the weather?\""
jobs:
  app-build: 
    name: ELIZA build on Ubuntu-latest
    runs-on: ubuntu-latest
    steps:
      - name: Checkout & Set Environment Variables
        uses: actions/checkout@v3
        
      - name: Qustion ELIZA ${{ inputs.statement }} 
        run: |
          cd $GITHUB_WORKSPACE
          python action.py --statement ${{ inputs.statement }} >> answer_sheet.txt
      - name: ELIZA Answer $GITHUB_ENV
        run: |
          echo "::group:: Result"
          echo "Q: ${{ inputs.statement }}"
          echo "A: $(cat answer_sheet.txt)"

 

 

 

formatter

Black formatter

• 자동 Python PEP8 format 교정(간혹 query문이나 코드 \t 띄어쓰기 문제로 Error) → 강제 변경

jobs:
  black:
    runs-on: ubuntu-20.04
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-python@v1
        with:
          python-version: 3.9
      - run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt
      - run: |
          black --check --verbose .

 

pull_request 생성

name: black-action
on: [push, pull_request]
jobs:
  linter_name:
    name: runner / black
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Check files using the black formatter
        uses: rickstaa/action-black@v1
        id: action_black
        with:
          black_args: "."
      - name: Create Pull Request
        if: steps.action_black.outputs.is_formatted == 'true'
        uses: peter-evans/create-pull-request@v5
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          title: "Format Python code with psf/black push"
          commit-message: ":art: Format Python code with psf/black"
          body: |
            There appear to be some python formatting errors in ${{ github.sha }}. This pull request
            uses the [psf/black](https://github.com/psf/black) formatter to fix these issues.
          base: ${{ github.head_ref }} # Creates pull request onto pull request or commit branch
          branch: actions/black

 

ruff formatter

• Flake8과 black을 대체하기 위해 rust로 만들어졌으며 python linter 중 가장 빠름
• check: linter check
• format: linter 적용

name: Apply Linter
runs-on: ubuntu-latest
steps:   
  - uses: actions/checkout@v4
  - uses: chartboost/ruff-action@v1 
    with:
      args: 'check --diff'
  - uses: chartboost/ruff-action@v1
    with:
      args: 'format --check'

 

 

docker setup buildx

• QEMU (optional) : 다양한 virtual env 지원하는 프로그램 주로 특수한 환경 (iot module)에서 많이 사용.
• Buildx : docker build 환경 구축

jobs:
  buildx:
    runs-on: ubuntu-latest
    steps:
      -
        name: Checkout
        uses: actions/checkout@v4
      -
        # Add support for more platforms with QEMU (optional)
        # https://github.com/docker/setup-qemu-action
        name: Set up QEMU
        uses: docker/setup-qemu-action@v3
      -
        name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v3

 

Slack Webhook

 Slack 메세지 발송

[Custom CI Result]

 

      - name: Send custom JSON data to Slack workflow
        id: slack
        uses: slackapi/slack-github-action@v1.24.0
        with:
          # For posting a rich message using Block Kit
          payload: |
            {
              "text": "GitHub Action build result: ${{ job.status }}\n${{ github.event.pull_request.html_url || github.event.head_commit.url }}",
              "blocks": [
                {
                  "type": "section",
                  "text": {
                    "type": "mrkdwn",
                    "text": "GitHub Action build result: ${{ job.status }}\n${{ github.event.pull_request.html_url || github.event.head_commit.url }}"
                  }
                }
              ]
            }
        env:
          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
          SLACK_WEBHOOK_TYPE: INCOMING_WEBHOOK

 

Secret Json

Secret Variable을 사용할 때 json format으로 변수를 생성하면 문자열의 format을 읽을 수 없어 error가 남.

이를 피하기 위해 base64 string을 사용해 credential_file을 생성

env:
  PREFECT_API_KEY: ${{ secrets.PREFECT_API_KEY }}
  PREFECT_API_URL: ${{ secrets.PREFECT_API_URL }}
  BASE64: ${{ secrets.BASE64 }}
  GCP_RESOURCE_REGION: ${{ secrets.GCP_RESOURCE_REGION }}
  GCP_PROJECT_ID: ${{ secrets.GCP_PROJECT_ID }}
  GCP_ARTIFACT_REPOSITORY_NAME: ${{ secrets.GCP_ARTIFACT_REPOSITORY_NAME }}
  FLOW_IMAGE_NAME: ${{ secrets.FLOW_IMAGE_NAME }}
# authenticating with Gcloud example
- name: Authenticate to Google Cloud
  uses: google-github-actions/auth@v1
  with:
    credentials_json: ${{ secrets.BASE64 }}
# authenticating with Docker example
- name: Build and push image to GAR
  run: |
    RAW_IMAGE=$GCP_RESOURCE_REGION-docker.pkg.dev/$GCP_PROJECT/$GCP_ARTIFACT_REPOSITORY_NAME/$FLOW_IMAGE_NAME
    IMAGE_URI=$GCP_RESOURCE_REGION-docker.pkg.dev/$GCP_PROJECT/$GCP_ARTIFACT_REPOSITORY_NAME/$FLOW_IMAGE_NAME:$GITHUB_SHA
    docker build -q \
    --build-arg PREFECT_API_KEY=$PREFECT_API_KEY \
    --build-arg PREFECT_API_URL=$PREFECT_API_URL \
    --build-arg BASE64=$BASE64 \
    -t $RAW_IMAGE \
    -f ./Dockerfiles/flows.Dockerfile .
    docker tag $RAW_IMAGE $IMAGE_URI
    docker push $RAW_IMAGE
    docker push $IMAGE_URI
    echo "IMAGE_URI=$IMAGE_URI" >> $GITHUB_OUTPUT
  shell: bash

https://medium.com/@verazabeida/using-json-in-your-github-actions-when-authenticating-with-gcp-856089db28cf

 

Using JSON in your GitHub Actions when authenticating with GCP

 

Reference

https://github.com/peter-evans/create-pull-request

GitHub - peter-evans/create-pull-request: A GitHub action to create a pull request for changes to your repository in the actions

 

https://github.com/marketplace/actions/run-black-formatter

Run black formatter - GitHub Marketplace

https://velog.io/@thovy/CICD-FastAPI-%EB%B0%B0%ED%8F%AC%ED%95%98%EA%B8%B0-AWS-EC2-Github-Actions-Docker

[CI/CD] FastAPI 배포하기 - AWS EC2, Github Actions, Docker