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: add missing id-token:write permission for Google Cloud #1276

Merged
merged 2 commits into from
Oct 20, 2024

Conversation

KeisukeYamashita
Copy link
Contributor

@KeisukeYamashita KeisukeYamashita commented Oct 20, 2024

Overview

Add missing permissions to authenticate with Google Cloud with workload federation.

What I've done

What I haven't done

How I tested

Ran the workflow: log.
Looks good.

Screenshot

Which point I want you to review particularly

Memo

Summary by CodeRabbit

  • Chores
    • Enhanced permissions for jobs in workflow files to improve authentication with Google Cloud.
    • Added a checkout step to the update token job.
    • Minor formatting adjustments for consistency across workflow files.

@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 370a65a
🔍 Latest deploy log https://app.netlify.com/sites/reearth-cms/deploys/671519193c9f920008568a6c

@KeisukeYamashita KeisukeYamashita marked this pull request as ready for review October 20, 2024 14:58
@KeisukeYamashita KeisukeYamashita merged commit f27d508 into main Oct 20, 2024
14 of 15 checks passed
Copy link
Contributor

coderabbitai bot commented Oct 20, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces modifications to two GitHub workflow files: .github/workflows/cron_ion_token_test.yml and .github/workflows/deploy_test.yml. Enhancements include the addition of permissions for various jobs to facilitate read access to contents and write access for ID tokens, enabling authentication with Google Cloud using OIDC. The workflows also incorporate the actions/checkout@v4 step in the cron_ion_token_test.yml file, along with minor formatting adjustments for consistency across both files.

Changes

File Change Summary
.github/workflows/cron_ion_token_test.yml Added permissions section for update_ion_token job; included actions/checkout@v4 step; minor formatting adjustments.
.github/workflows/deploy_test.yml Added permissions sections for deploy_web_gcs, deploy_server, deploy_web, and deploy_worker jobs; minor formatting adjustments.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHub Actions
    participant Google Cloud

    User->>GitHub Actions: Trigger workflow
    GitHub Actions->>GitHub Actions: Check out code (actions/checkout@v4)
    GitHub Actions->>Google Cloud: Authenticate (OIDC)
    GitHub Actions->>Google Cloud: Perform deployment/update tasks
    Google Cloud-->>GitHub Actions: Confirm actions completed
    GitHub Actions-->>User: Workflow completed
Loading

🐇 "In the meadow where the tokens play,
Permissions added, hip-hip-hooray!
With actions checked out, we leap and bound,
To Google Cloud, our dreams are found.
Formatting neat, like a rabbit's nest,
Our workflows now run at their very best!" 🐇


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.

@KeisukeYamashita KeisukeYamashita deleted the add-missing-id-token-permission branch October 20, 2024 14:58
caichi-t pushed a commit that referenced this pull request Oct 23, 2024
* ci: add missing id-token permission for gc auth

Signed-off-by: KeisukeYamashita <[email protected]>

* ci: add missing `actions/checkout` before google cloud auth

Signed-off-by: KeisukeYamashita <[email protected]>

---------

Signed-off-by: KeisukeYamashita <[email protected]>
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