Skip to content

Adds support for .upmconfig.toml in Windows Docker images #705

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

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

lupidan
Copy link

@lupidan lupidan commented Apr 29, 2025

Changes

  • Similarly to what it does for Linux, Windows now creates a _github_home folder in the runner's temp folder if it does not exist.
  • Updates Windows Docker model to mount the _github_home from the temp folder into C:\githubhome, to align with the current documentation that works on macoOS and ubuntu.
  • Updates Windows entrypoint.ps1 to check if a .upmconfig.toml is available in C:\githubhome, and copies it into current user's home folder, so Unity can see it.

Checklist

  • Read the contribution guide and accept the
    code of conduct

Summary by CodeRabbit

  • New Features
    • Added support for mounting a new directory as a volume in Windows Docker containers, mapping a host directory to C:/githubhome inside the container.

Copy link

coderabbitai bot commented Apr 29, 2025

📝 Walkthrough

Walkthrough

The update modifies the Windows Docker command generation logic to add a volume mount for a _github_home directory within the runner's temporary path. Before constructing the Docker command, it ensures the directory exists, and then mounts it into the container at C:/githubhome. No other command parameters or exported interfaces are changed.

Changes

File(s) Change Summary
src/model/docker.ts Updated Windows Docker command generation to add a _github_home volume mount; ensures directory exists before command construction.

Poem

In the world of Docker, a new path is shown,
_github_home is mounted, its purpose now known.
Windows commands updated, the temp path checked,
Into C:/githubhome, the directory is decked.
With volumes aligned, the containers will roam—
A rabbit’s delight in its new Docker home! 🐇🪄


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 81ed299 and d4e973c.

⛔ Files ignored due to path filters (3)
  • dist/index.js is excluded by !**/dist/**
  • dist/index.js.map is excluded by !**/dist/**, !**/*.map
  • dist/platforms/windows/entrypoint.ps1 is excluded by !**/dist/**
📒 Files selected for processing (1)
  • src/model/docker.ts (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
src/model/docker.ts (2)
src/model/input.ts (3)
  • runnerTempPath (114-116)
  • dockerWorkspacePath (240-242)
  • gitPrivateToken (202-204)
src/model/action.ts (1)
  • workspace (36-38)
🔇 Additional comments (3)
src/model/docker.ts (3)

91-101: LGTM: Appropriate parameter extraction

The code now correctly extracts runnerTempPath from parameters to use for GitHub home directory setup on Windows, aligning with the Linux implementation.


103-105: Good implementation of GitHub home directory creation

This change creates a _github_home directory within the runner's temporary path for Windows, mirroring the existing implementation for Linux environments (lines 54-55). This is essential for supporting the .upmconfig.toml file for UPM authentication as mentioned in the PR objectives.


113-113: Excellent Windows volume mapping implementation

The volume mapping from the host's _github_home directory to C:/githubhome inside the Windows container completes the implementation. This aligns with the PR's objective to support .upmconfig.toml in Windows Docker images and creates consistency with the Linux implementation (which maps to /root at line 68).

According to the PR description, the entrypoint.ps1 script (referenced at line 127) will handle copying any .upmconfig.toml file from this location to the user's home directory where Unity can access it.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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

Cat Gif

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.

1 participant