Skip to content

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

Merged
davidmfinol merged 14 commits intogame-ci:mainfrom
lupidan:feature/WindowsUPMConfigFix
Jun 7, 2025
Merged

Adds support for .upmconfig.toml in Windows Docker images#705
davidmfinol merged 14 commits intogame-ci:mainfrom
lupidan:feature/WindowsUPMConfigFix

Conversation

@lupidan
Copy link
Contributor

@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.

@coderabbitai
Copy link

coderabbitai bot commented Apr 29, 2025

Important

Review skipped

Review was skipped due to path filters

⛔ 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/**

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 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! 🐇🪄


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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.

@github-actions
Copy link

Cat Gif

@davidmfinol
Copy link
Member

@lupidan Can you pull from main and rebuild to update this PR?

lupidan added 2 commits June 7, 2025 10:25
# Conflicts:
#	dist/index.js
#	dist/index.js.map
After `yarn` + `npm run build`
@lupidan
Copy link
Contributor Author

lupidan commented Jun 7, 2025

@davidmfinol Sorry about that, I finally found some time to update my PR branch. 🙌

I merged the latest main branch and I did re-run:

yarn
npm run build

The licenses.txt file seemed to be missing some information too, so I did commit it, to keep updated. (Doesn't seem to be something related to the code I just added)
Let me know if this makes sense, or if I need to do something else.

@codecov
Copy link

codecov bot commented Jun 7, 2025

Codecov Report

Attention: Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.

Project coverage is 37.05%. Comparing base (a1ebdb7) to head (d23d05a).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
src/model/docker.ts 0.00% 2 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #705      +/-   ##
==========================================
- Coverage   37.07%   37.05%   -0.03%     
==========================================
  Files          77       77              
  Lines        3161     3163       +2     
  Branches      625      626       +1     
==========================================
  Hits         1172     1172              
- Misses       1989     1991       +2     
Files with missing lines Coverage Δ
src/model/docker.ts 10.20% <0.00%> (-0.44%) ⬇️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@davidmfinol davidmfinol merged commit 65607f9 into game-ci:main Jun 7, 2025
5 checks passed
@webbertakken
Copy link
Member

Released in v4.6.0

@lupidan lupidan deleted the feature/WindowsUPMConfigFix branch October 20, 2025 21:33
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.

3 participants