시작하기 전에

1. IBM Cloud 프로젝트 서비스에서 편집자 역할이 있는지 확인하세요.
2. 프로젝트를 Git 저장소에 연결하는 단계를 완료하세요. 이 튜토리얼의 목적을 위해 빈 프로젝트를 GitHub 저장소에 연결합니다.

GitHub 에 비밀과 변수 추가

프로젝트에 연결한 GitHub 저장소에 비밀과 변수를 생성합니다. 이러한 비밀과 변수는 GitHub 워크플로에서 사용됩니다. 다음 비밀과 변수를 추가합니다.

1. 프로젝트를 인증하려면 GitHub 워크플로에 IBM Cloud API 키를 포함해야 합니다. API 키를 안전하게 유지하려면 저장소에 대한 비밀을 만드는 단계를 완료하여 GitHub 에서 API 키를 비밀로 저장합니다. 이 튜토리얼의 목적을 위해 비밀 이름을 IBM_CLOUD_API_KEY 로 지정합니다.

2. 다음으로, GitHub 저장소에 대한 구성 변수를 생성하는 단계를 완료합니다. 다음 변수를 저장하세요.

   GitHub 저장소에 저장할 변수 목록

   변수 이름	값	설명
   CONFIG_FOLDER_PATH	configs	프로젝트에 연결된 저장소 폴더의 경로입니다. 이 폴더에는 프로젝트의 구성 파일이 들어 있습니다.
   IAM_URL	https://iam.cloud.ibm.com	URL 에서 Cloud Identity and Access Management 으로 이동합니다.
   PROJECTS_API_BASE_URL	https://projects.api.cloud.ibm.com	프로젝트 API의 URL.

GitHub 에서 워크플로 생성

프로젝트에 연결한 GitHub 저장소에서 워크플로를 작성하는 단계를 완료하세요.

GitHub 에서 필요에 따라 수정할 수 있는 예제 워크플로 파일 로 시작해 보세요.

필요한 만큼의 작업 수에 맞게 워크플로를 사용자 정의할 수 있습니다. 하지만 리포지토리의 사이드 브랜치에서 메인 브랜치로 변경 사항이 병합될 때 프로젝트의 구성을 성공적으로 업데이트하려면 다음 코드를 포함해야 합니다.

1. 메인 브랜치에 대한 풀 리퀘스트가 닫힐 때 워크플로를 트리거하려면 워크플로의 on 섹션에 types: [closed] 추가합니다.

      # Controls when the workflow will run
      on:
        # Triggers the workflow on push or pull request events but only for the "main" branch
        # push:
        #   branches: [ "main" ]
        pull_request:
          branches: [ "main" ]
          types: [closed]
   

2. 변경 사항이 메인 브랜치에 병합될 때 이 워크플로를 트리거하는 if 명령문을 추가합니다.

   jobs:
     update-config:
       if: github.event.pull_request.merged == true
       runs-on: ubuntu-latest
   

3. 다음 코드를 워크플로에 포함하면 저장소가 프로젝트에 연결할 수 있습니다. 여기서 IBM_CLOUD_API_KEY 은 GitHub:

     IAM_TOKEN=$(curl -X POST "https://iam.cloud.ibm.com/identity/token" \
           -H "Content-Type: application/x-www-form-urlencoded" \
            -H "Accept: application/json" \
            -d "grant_type=urn:ibm:params:oauth:grant-type:apikey&apikey=${{ secrets.IBM_CLOUD_API_KEY }}" | jq -r .access_token)
   

4. 어떤 구성이 편집되었는지 식별하려면 다음 코드를 포함하세요.

             # get files changed in the PR
             changed_files=$(git diff --name-only HEAD^ HEAD)
             echo "Changed files: $changed_files"
   
             for file in $changed_files; do
               # find config files that were changed
               if [[ "${file}" == ${{ vars.CONFIG_FOLDER_PATH }}/* ]] && [ -s "${file}" ]; then
                 echo "Config file updated: ${file}"
   
                 # extract data from config files
                 PROJECT_ID=$(jq -r '.project_id' $file)
                 CONFIG_ID=$(jq -r '.config_id' $file)
                 DEF=$(jq '.definition' $file)
   
                 echo "Project ID: ${PROJECT_ID}"
                 echo "Config ID: ${CONFIG_ID}"
   

5. 프로젝트에서 편집된 구성을 업데이트하려면 다음 코드를 포함하세요.

                 # update config definition
                 RESPONSE=$(curl -X PATCH "${BASE_URL}/v1/projects/${PROJECT_ID}/configs/${CONFIG_ID}" \
                 --header "Authorization: Bearer ${IAM_TOKEN}" \
                 --header "Accept: application/json" \
                 --header "Content-Type: application/json" \
                 --data "{ \"definition\": ${DEF} }")
   

name: Projects Git Integration Workflow

# Controls when the workflow will run
on:
  # Triggers the workflow on push or pull request events but only for the "main" branch
  pull_request:
    branches: [ "main" ]
    types: [closed]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

jobs:
  update-configs:
    if: github.event.pull_request.merged == true
    runs-on: ubuntu-latest
    steps:
      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Update Project Configs
        run: |
          IAM_TOKEN=$(curl -X POST "${{ vars.IAM_URL }}/identity/token" \
          -H "Content-Type: application/x-www-form-urlencoded" \
          -H "Accept: application/json" \
          -d "grant_type=urn:ibm:params:oauth:grant-type:apikey&apikey=${{ secrets.IBM_CLOUD_API_KEY }}" | jq -r .access_token)

          BASE_URL=${{ vars.PROJECTS_API_BASE_URL }}

          # get files changed in the PR
          changed_files=$(git diff --name-only HEAD^ HEAD)
          echo "Changed files: $changed_files"

          for file in $changed_files; do
            # find config files that were changed
            if [[ "${file}" == ${{ vars.CONFIG_FOLDER_PATH }}/* ]] && [ -s "${file}" ]; then
              echo "Config file updated: ${file}"

              # extract data from config files
              PROJECT_ID=$(jq -r '.project_id' $file)
              CONFIG_ID=$(jq -r '.config_id' $file)
              DEF=$(jq '.definition' $file)

              echo "Project ID: ${PROJECT_ID}"
              echo "Config ID: ${CONFIG_ID}"

              # update config definition
              RESPONSE=$(curl -X PATCH "${BASE_URL}/v1/projects/${PROJECT_ID}/configs/${CONFIG_ID}" \
              --header "Authorization: Bearer ${IAM_TOKEN}" \
              --header "Accept: application/json" \
              --header "Content-Type: application/json" \
              --data "{ \"definition\": ${DEF} }")

              echo $RESPONSE
              ERR_CODE=$(echo $RESPONSE | jq '.code')
              if [ "${ERR_CODE}" != "null" ]; then
                exit 1
              fi
            else
              echo "Not a project configuration file: ${file}"
            fi
          done

워크플로 테스트

이제 GitHub, 에서 워크플로가 생성되었으므로 프로젝트에 구성을 추가하여 워크플로가 성공적으로 실행되는지 확인하세요. 다음 단계를 완료하십시오.

1. IBM Cloud 콘솔에서 탐색 메뉴 아이콘 > 프로젝트를 클릭하고 GitHub 저장소에 연결된 프로젝트를 선택합니다.

2. 프로젝트에 구성을 추가하려면 '만들기'를 클릭하세요. 구성이 저장될 사이드 브랜치를 선택해야 합니다.

3. 구성을 편집하십시오. 예를 들어, 구성 패널에서 인증 방법을 추가합니다.

4. 변경 사항을 커밋할 사이드 브랜치를 선택합니다.

5. 커미트를 클릭하십시오.

6. GitHub 저장소로 가서 풀 리퀘스트를 열어 사이드 브랜치를 저장소의 메인 브랜치에 병합합니다.

7. 사이드 브랜치가 메인 브랜치에 병합될 때 워크플로가 실행되는지 확인하세요. GitHub 저장소와 프로젝트에서 확인할 수 있습니다.

   1. GitHub 저장소에서 작업 탭으로 이동하여 워크플로를 선택합니다. 업데이트가 성공적으로 실행되었는지 확인합니다.
   2. 프로젝트에서 추가한 구성에 대해 옵션 아이콘 > > 편집을 클릭하고 메인 브랜치로 전환합니다. 업데이트가 적용되었는지 확인하세요. 예를 들어, 이전에 추가한 인증 방법은 구성 패널에 포함됩니다.