Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🚀 Change staging deploy method from ECR to github registry #393

Merged

Conversation

dohyun-ko
Copy link
Member

@dohyun-ko dohyun-ko commented Nov 20, 2024

Summary by CodeRabbit

  • 새로운 기능
    • GitHub Actions 워크플로우에 새로운 환경 변수를 추가하여 Docker 이미지 빌드 및 푸시 프로세스를 개선했습니다.
  • 개선 사항
    • Docker 이미지 빌드 및 푸시 단계가 재구성되어 메타데이터 추출 및 사용이 간소화되었습니다.
    • Kubernetes 매니페스트 업데이트 과정에서 새로운 환경 변수를 참조하도록 변경되었습니다.
    • 빌드 작업 이름이 "Build docker image"로 변경되었습니다.

Copy link
Contributor

coderabbitai bot commented Nov 20, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

이 PR은 .github/workflows/staging.yaml 파일의 GitHub Actions 워크플로우를 수정합니다. 새로운 workflow_dispatch 트리거가 추가되어 수동 실행이 가능해졌으며, REGISTRY, REPOSITORY, IMAGE_TAG 변수를 정의하는 환경 섹션이 추가되었습니다. build 작업은 "Build docker image"로 이름이 변경되었고, 컨테이너 레지스트리에 로그인하는 새로운 단계가 포함되었습니다. Docker 이미지 빌드 및 푸시 단계가 재구성되었으며, deploy 작업에서도 새로운 환경 변수를 사용하도록 업데이트되었습니다.

Changes

파일 경로 변경 요약
.github/workflows/staging.yaml - 새로운 환경 변수 REGISTRY, REPOSITORY, IMAGE_TAG 추가
- build 작업 이름 변경
- 로그인 단계 추가
- Docker 이미지 빌드 및 푸시 단계 재구성
- deploy 작업에서 ECR 관련 변수 제거 및 새로운 변수로 업데이트

Possibly related issues

  • gsainfoteam/ziggle-fe#392: ECR에서 GitHub 레지스트리로 변경해야 하며, 이 PR의 변경 사항이 해당 문제를 해결합니다.

Poem

🐇
새로운 변수들로 가득 찬 이곳,
이미지 빌드가 더욱 간편해졌죠.
레지스트리와 리포지토리,
함께하는 우리의 여정,
배포도 이제는 수월하니,
모두가 행복한 이 순간을 기리며! 🌟

Warning

Rate limit exceeded

@dohyun-ko has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 23 minutes and 1 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 2ad806c and 7f5145b.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (2)
.github/workflows/staging.yaml (2)

Line range hint 55-87: ECR 관련 단계들을 제거해야 합니다.

GitHub Container Registry로 마이그레이션하는 과정에서 기존 ECR 관련 설정이 그대로 남아있습니다. 이는 불필요한 중복 작업을 유발할 수 있습니다.

다음 단계들을 제거해 주세요:

  • AWS 자격 증명 설정
  • ECR 로그인
  • ECR로의 이미지 빌드 및 푸시
-      - name: Configure AWS credentials
-        uses: aws-actions/configure-aws-credentials@v4
-        with:
-          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
-          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-          aws-region: ap-northeast-2
-
-      - name: Login to Amazon ECR
-        id: login-ecr
-        uses: aws-actions/amazon-ecr-login@v2
-
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
-
-      - name: Build, tag, and push image to Amazon ECR
-        uses: docker/build-push-action@v5
-        env:
-          ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
-          ECR_REPOSITORY: ziggle-frontend
-          IMAGE_TAG: dev${{ github.run_number }}
-        with:
-          context: .
-          push: true
-          tags: ${{ env.ECR_REGISTRY }}/${{ env.ECR_REPOSITORY }}:${{ env.IMAGE_TAG }}
-          cache-from: type=gha
-          cache-to: type=gha,mode=max
🧰 Tools
🪛 yamllint

[error] 43-43: trailing spaces

(trailing-spaces)


43-43: 후행 공백을 제거해 주세요.

43번 라인에 불필요한 공백이 있습니다.

🧰 Tools
🪛 yamllint

[error] 43-43: trailing spaces

(trailing-spaces)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 495ed91 and 2ad806c.

📒 Files selected for processing (1)
  • .github/workflows/staging.yaml (3 hunks)
🧰 Additional context used
🪛 yamllint
.github/workflows/staging.yaml

[error] 43-43: trailing spaces

(trailing-spaces)

🔇 Additional comments (2)
.github/workflows/staging.yaml (2)

8-11: 환경 변수 설정이 적절합니다.

GitHub Container Registry를 위한 환경 변수들이 잘 정의되어 있습니다.


27-54: GitHub Container Registry 관련 설정이 올바르게 구성되었습니다.

Docker 이미지 빌드 및 푸시 과정이 GitHub Container Registry에 맞게 잘 구성되어 있습니다. 캐시 설정도 적절히 되어있어 빌드 성능도 최적화되어 있습니다.

🧰 Tools
🪛 yamllint

[error] 43-43: trailing spaces

(trailing-spaces)

.github/workflows/staging.yaml Show resolved Hide resolved
Copy link

@dohyun-ko dohyun-ko enabled auto-merge November 20, 2024 02:38
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
.github/workflows/staging.yaml (1)

Line range hint 55-89: 불필요한 중복 코드와 사용하지 않는 ECR 관련 단계를 제거해주세요.

다음과 같은 문제점들이 발견되었습니다:

  1. Docker Buildx 설정이 중복되어 있습니다 (43행과 71행)
  2. ECR 관련 단계들이 더 이상 사용되지 않습니다 (56-85행)

다음과 같이 수정하는 것을 제안드립니다:

      - name: Build and push Docker image
        id: push
        uses: docker/build-push-action@v6
        with:
          context: .
          push: true
          tags: ${{ steps.meta.outputs.tags }}
          labels: ${{ steps.meta.outputs.labels }}
          cache-from: type=gha
          cache-to: type=gha,mode=max

-      - name: Configure AWS credentials
-        uses: aws-actions/configure-aws-credentials@v4
-        with:
-          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
-          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-          aws-region: ap-northeast-2
-
-      - name: Login to Amazon ECR
-        id: login-ecr
-        uses: aws-actions/amazon-ecr-login@v2
-
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
-
-      - name: setup environment
-        run: |
-          echo "${{ vars.ENV }}" >> .env.production
-          echo "NEXTAUTH_SECRET=${{ secrets.NEXTAUTH_SECRET }}" >> .env.production
-          echo "IDP_CLIENT_SECRET=${{ secrets.IDP_CLIENT_SECRET }}" >> .env.production
-
-      - name: Build, tag, and push image to Amazon ECR
-        uses: docker/build-push-action@v5
-        env:
-          ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
-          ECR_REPOSITORY: ziggle-frontend
-          IMAGE_TAG: dev${{ github.run_number }}
-        with:
-          context: .
-          push: true
-          tags: ${{ env.REGISTRY }}/${{ env.REPOSITORY }}:${{ env.IMAGE_TAG }}
-          cache-from: type=gha
-          cache-to: type=gha,mode=max
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2ad806c and 7f5145b.

📒 Files selected for processing (1)
  • .github/workflows/staging.yaml (3 hunks)
🧰 Additional context used
🪛 yamllint
.github/workflows/staging.yaml

[error] 44-44: trailing spaces

(trailing-spaces)

🔇 Additional comments (3)
.github/workflows/staging.yaml (3)

7-12: 수동 실행 트리거와 환경 변수 설정이 적절합니다!

워크플로우 디스패치 트리거 추가와 GitHub Container Registry를 위한 환경 변수 설정이 잘 되어있습니다.


28-54: GitHub Container Registry 설정이 올바르게 구성되었습니다!

컨테이너 레지스트리 로그인, 메타데이터 추출, 그리고 빌드/푸시 단계가 잘 구성되어 있습니다.

🧰 Tools
🪛 yamllint

[error] 44-44: trailing spaces

(trailing-spaces)


104-104: 매니페스트 파일 존재 여부를 확인해주세요.

infoteam/service/ziggle/next.stg.yaml 파일이 올바른 위치에 있는지 확인이 필요합니다.

다음 스크립트를 실행하여 매니페스트 파일의 존재 여부를 확인합니다:

Copy link

@dohyun-ko dohyun-ko merged commit baed83f into master Nov 20, 2024
3 checks passed
This was referenced Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] fix deploy action to match with devops changes
2 participants