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

Dev/buildImagePerPR #231

Merged
merged 5 commits into from
Oct 22, 2024
Merged

Dev/buildImagePerPR #231

merged 5 commits into from
Oct 22, 2024

Conversation

Pugma
Copy link
Collaborator

@Pugma Pugma commented Oct 18, 2024

User description

PR がオープンされるごとにイメージのビルドを行い、k8s を介した開発環境が起動されるようにしました

同様の機能が実装されていた traQ_S-UI や NeoShowcase のリポジトリを参考にして実装しました

確認をお願いします


PR Type

enhancement, other


Description

  • PRがオープンされるたびにDockerイメージをビルドし、GitHub Container Registryにプッシュするワークフローを追加しました。
  • PRがオープンされた際に、プレビュー環境のURLをコメントするGitHub Actionsを追加しました。
  • 本番と開発の両方のプレビューURLを生成し、PRコメントに追加します。

Changes walkthrough 📝

Relevant files
Enhancement
preview-comment.yaml
プレビュー環境URLをコメントするGitHub Actionsの追加                                             

.github/workflows/preview-comment.yaml

  • 新しいGitHub Actionsワークフローを追加
  • PRがオープンされたときにプレビュー環境のURLをコメント
  • 本番と開発のプレビューURLを生成
  • +33/-0   
    preview.yaml
    PRごとのDockerイメージビルドワークフローの追加                                                           

    .github/workflows/preview.yaml

  • 新しいGitHub Actionsワークフローを追加
  • PRごとにDockerイメージをビルド
  • GitHub Container Registryにプッシュ
  • +51/-0   

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Security Concern
    プルリクエストのヘッドSHAを参照してビルドを行うことで、悪意のあるコードがビルドプロセスに影響を与える可能性があります。特に、プルリクエストが外部からのものである場合、悪意ある変更がビルドプロセスに組み込まれるリスクがあります。

    Hardcoded URL
    プレビュー環境のURLがハードコードされており、将来的にURLが変更された場合にメンテナンスが困難になる可能性があります。また、異なる環境やプロジェクトにこのワークフローを再利用する場合にも変更が必要です。

    Copy link

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    Security
    Docker イメージのビルドにおける認証情報のセキュリティを強化する。

    Docker イメージのビルドに使用する GitHub Container Registry の認証情報は、セキュアな方法で管理し、公開されないようにしてください。

    .github/workflows/preview.yaml [39-41]

    -username: traptitech
    -password: ${{ secrets.GITHUB_TOKEN }}
    +username: ${{ secrets.REGISTRY_USERNAME }}
    +password: ${{ secrets.REGISTRY_PASSWORD }}
    Suggestion importance[1-10]: 8

    Why: This suggestion improves security by replacing hardcoded credentials with secrets, reducing the risk of exposing sensitive information.

    8

    .github/workflows/preview-comment.yaml Show resolved Hide resolved
    .github/workflows/preview-comment.yaml Outdated Show resolved Hide resolved
    .github/workflows/preview.yaml Outdated Show resolved Hide resolved
    @Pugma Pugma requested a review from cp-20 October 22, 2024 05:42
    @Pugma Pugma merged commit bd4dcd2 into main Oct 22, 2024
    8 checks passed
    @Pugma Pugma deleted the dev/buildImagePerPR branch October 22, 2024 05:47
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants