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

ci: update Cesium ION token of reearth-cms-web Cloud Run service #1275

Merged
merged 2 commits into from
Oct 21, 2024

Conversation

KeisukeYamashita
Copy link
Contributor

@KeisukeYamashita KeisukeYamashita commented Oct 20, 2024

Overview

Because now the Re:Earth CMS frontend (web) has been Docker-ized, we must update the environment variables instead of updating the reearth_config.json on GCS.

What I've done

What I haven't done

How I tested

I ran the workflow by dispatching the event and confirmed that it's working: log

Screenshot

Which point I want you to review particularly

Memo

Summary by CodeRabbit

  • New Features
    • Introduced a scheduled workflow to update the Cloud Run service on the 2nd day of every month at midnight.
    • Added new environment variables for improved configuration management.
  • Bug Fixes
    • Streamlined the process for updating the Cesium Ion token by directly updating the Cloud Run service.

Signed-off-by: KeisukeYamashita <19yamashita15@gmail.com>
@KeisukeYamashita KeisukeYamashita self-assigned this Oct 20, 2024
@github-actions github-actions bot added the ci label Oct 20, 2024
Copy link

netlify bot commented Oct 20, 2024

Deploy Preview for reearth-cms canceled.

Name Link
🔨 Latest commit 88935d0
🔍 Latest deploy log https://app.netlify.com/sites/reearth-cms/deploys/67151aba89cc2b000892dd07

@KeisukeYamashita KeisukeYamashita marked this pull request as ready for review October 20, 2024 14:46
Copy link

coderabbitai bot commented Oct 20, 2024

Walkthrough

The pull request modifies the workflow file .github/workflows/cron_ion_token_test.yml. It updates the workflow's trigger to run on a cron schedule at midnight on the 2nd day of every month. Several environment variables are changed: GCS_DOMAIN and REEARTH_CONFIG_FILENAME are removed, while CMS_WEB and REGION are added. The job update_ion_token now includes a step to check out the repository and updates a Cloud Run service with a Cesium Ion token instead of modifying a configuration file.

Changes

File Path Change Summary
.github/workflows/cron_ion_token_test.yml - Trigger updated to cron schedule (2nd day of month at midnight)
- Environment variables modified: GCS_DOMAIN, REEARTH_CONFIG_FILENAME removed; CMS_WEB, REGION added
- Added checkout step using actions/checkout@v4
- Renamed step from "Update Ion token in reearth config" to "Update Cloud Run"
- Logic changed to update Cloud Run service with the token instead of a configuration file

Poem

🐇 In the moonlight, the cron does play,
On the second night, it finds its way.
Tokens now dance in the Cloud Run's embrace,
With new variables set, they quicken the pace.
Hopping along, we celebrate this change,
In the world of code, nothing feels strange! 🌙✨


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

@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 (2)
.github/workflows/cron_ion_token_test.yml (2)

36-41: LGTM with a suggestion: Update Cloud Run step looks good, but consider improving quoting.

The change from updating a configuration file to directly updating the Cloud Run service aligns well with the PR objectives. The use of environment variables makes the command more maintainable.

However, to prevent potential issues with word splitting if the token contains spaces, consider wrapping the environment variable value in quotes:

 gcloud run services update $CMS_WEB \
-  --update-env-vars REEARTH_CMS_CESIUM_ION_ACCESS_TOKEN=${{ steps.ion_token.outputs.token }} \
+  --update-env-vars REEARTH_CMS_CESIUM_ION_ACCESS_TOKEN="${{ steps.ion_token.outputs.token }}" \
   --region $REGION \
   --platform managed
🧰 Tools
🪛 actionlint

37-37: shellcheck reported issue in this script: SC2086:info:1:28: Double quote to prevent globbing and word splitting

(shellcheck)


37-37: shellcheck reported issue in this script: SC2086:info:3:12: Double quote to prevent globbing and word splitting

(shellcheck)


Line range hint 1-41: Overall changes look good. Consider updating related documentation.

The workflow has been successfully updated to work with a Cloud Run service instead of modifying a configuration file. This aligns well with the PR objectives and should result in a more efficient process for updating the Cesium Ion token.

To ensure smooth operation and maintainability:

  1. Update any documentation that references the old configuration file update process.
  2. Verify that no other parts of the system still rely on the removed reearth_config.json file.
  3. Consider adding a comment in the workflow file explaining the purpose of the monthly token update.
🧰 Tools
🪛 actionlint

20-20: shellcheck reported issue in this script: SC2086:info:15:30: Double quote to prevent globbing and word splitting

(shellcheck)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between e828520 and 2286c30.

📒 Files selected for processing (1)
  • .github/workflows/cron_ion_token_test.yml (2 hunks)
🧰 Additional context used
🪛 actionlint
.github/workflows/cron_ion_token_test.yml

37-37: shellcheck reported issue in this script: SC2086:info:1:28: Double quote to prevent globbing and word splitting

(shellcheck)


37-37: shellcheck reported issue in this script: SC2086:info:3:12: Double quote to prevent globbing and word splitting

(shellcheck)

🔇 Additional comments (2)
.github/workflows/cron_ion_token_test.yml (2)

7-8: LGTM: Environment variables added for Cloud Run service.

The addition of CMS_WEB and REGION environment variables is appropriate for the updated workflow that now interacts with a Cloud Run service. These variables will be used in the Cloud Run update command later in the workflow.


13-13: LGTM: Repository checkout step added.

The addition of the actions/checkout@v4 step is appropriate. This ensures that the workflow has access to the repository contents, which may be necessary for subsequent steps. Using the latest version (v4) of the action is also a good practice.

@KeisukeYamashita KeisukeYamashita marked this pull request as draft October 20, 2024 14:49
@KeisukeYamashita KeisukeYamashita marked this pull request as ready for review October 20, 2024 15:00
@KeisukeYamashita KeisukeYamashita merged commit afe6c7a into main Oct 21, 2024
16 checks passed
@KeisukeYamashita KeisukeYamashita deleted the update-env-instead branch October 21, 2024 14:36
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.

2 participants