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

feat(web): dockerize web application #33

Merged
merged 1 commit into from
Dec 1, 2024
Merged

Conversation

KeisukeYamashita
Copy link
Contributor

@KeisukeYamashita KeisukeYamashita commented Dec 1, 2024

Overview

I've Dockerized the web application to be portable and deployable to container runtimes (e.g. Cloud Run, Kubernetes). We aim to host the web on Cloud Run.

What I've done

I've containerised the application and implemented the deployment workflow.

What I haven't done

I haven't decommissioned our GCS stuff yet.
I've implemented it separately from the existing system so that we can deploy, test, and switch over without any impact.

How I tested

Which point I want you to review particularly

Memo

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced separate jobs for building and deploying server and web components.
    • Added a new job for deploying the web application to AWS.
    • Implemented a new deployment process for Cloud Run with updated environment variables.
    • Added a .dockerignore file to streamline Docker builds.
    • Introduced a new Nginx configuration template and JSON configuration template for the Reearth application.
  • Bug Fixes

    • Updated to use the latest versions of various GitHub Actions for improved reliability.
  • Chores

    • Refactored Dockerfile to support multi-stage builds for the web application.

@KeisukeYamashita KeisukeYamashita self-assigned this Dec 1, 2024
Copy link

coderabbitai bot commented Dec 1, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes encompass multiple workflow files in the GitHub Actions setup for building, deploying, and managing Docker images for a web application. A new job for building a legacy Docker image has been added, and existing jobs have been updated to reflect new naming conventions and image specifications. Additionally, new deployment jobs for AWS and Google Cloud Run have been introduced, along with corresponding environment variables. New Docker-related files, including a .dockerignore, Dockerfile, and configuration templates, have been created to support the web application’s build and deployment processes.

Changes

File Path Change Summary
.github/workflows/build_web.yml Added job build-docker-image-legacy, updated job build-docker-image with new image name and action versions.
.github/workflows/ci_docker_build_push.yml Split Docker build job into server and web, updated job names and environment variables.
.github/workflows/deploy_aws.yml Added job deploy_web for web application deployment, introduced new environment variables.
.github/workflows/deploy_web_nightly.yml Introduced deploy_test job for Google Cloud Run, added new environment variables, renamed old deployment job.
web/.dockerignore Created new .dockerignore file to specify files to ignore during Docker build.
web/Dockerfile Added new Dockerfile with builder and production stages for web application.
web/docker/40-envsubst-on-reearth-config.sh Added script to modify HTML files and generate JSON config based on environment variables.
web/docker/nginx.conf.template Introduced new Nginx configuration template with custom log format and server block.
web/docker/reearth_config.json.template Created new JSON configuration template for the Reearth application with placeholders for dynamic values.

Poem

🐰 In the land of code, where changes bloom,
New jobs arise, dispelling gloom.
Docker images built with care,
Deployments soar through the air!
With templates and scripts, our work's a delight,
Hopping ahead, we code through the night! 🌙✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 11f1dd6 and b7a34a8.

📒 Files selected for processing (9)
  • .github/workflows/build_web.yml (2 hunks)
  • .github/workflows/ci_docker_build_push.yml (4 hunks)
  • .github/workflows/deploiy_aws.yml (2 hunks)
  • .github/workflows/deploy_web_nightly.yml (2 hunks)
  • web/.dockerignore (1 hunks)
  • web/Dockerfile (1 hunks)
  • web/docker/40-envsubst-on-reearth-config.sh (1 hunks)
  • web/docker/nginx.conf.template (1 hunks)
  • web/docker/reearth_config.json.template (1 hunks)

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.

@github-actions github-actions bot added the web label Dec 1, 2024
Copy link

netlify bot commented Dec 1, 2024

Deploy Preview for reearth-classic canceled.

Name Link
🔨 Latest commit b7a34a8
🔍 Latest deploy log https://app.netlify.com/sites/reearth-classic/deploys/674c7353de42290008231eb9

@KeisukeYamashita KeisukeYamashita force-pushed the dockerize-web branch 2 times, most recently from f658922 to 035fb6a Compare December 1, 2024 14:24
Signed-off-by: KeisukeYamashita <[email protected]>
@KeisukeYamashita KeisukeYamashita marked this pull request as ready for review December 1, 2024 16:18
@KeisukeYamashita KeisukeYamashita merged commit 272cd97 into main Dec 1, 2024
13 checks passed
@KeisukeYamashita KeisukeYamashita deleted the dockerize-web branch December 1, 2024 16:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant