Improve documentation for workspace ownership mismatches #3284
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… git directory' 'git status' prints a more informative error message than other git commands in certain failure scenarios, specifically including when the workspace is not owned by the user executing 'git'. Hopefully printing this extra error message will make it more obvious to operators what is going on if they encounter this kind of failure.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3284 +/- ##
==========================================
- Coverage 91.19% 91.12% -0.08%
==========================================
Files 167 167
Lines 3408 3413 +5
Branches 304 283 -21
==========================================
+ Hits 3108 3110 +2
- Misses 300 303 +3 ☔ View full report in Codecov by Sentry. |
|
Looks like Codecov is complaining about the fallback code not being tested. This isn't the kind of thing I would typically write a test for, so I'll probably hold off on doing so until I get some feedback about whether this change would be welcome or not. If it's welcome and just needs to be tested, I'll follow up! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Git requires that a repository directory be owned by the user executing
git. In the normal case, it will print a messagewhich is easily searchable online, but unfortunately
git configdoes not print such a nice message, and simply printswhich is misleading and hard to diagnose.
This came up for us when running Scala Steward as a AWS Fargate task using AWS EFS as its persistent storage. We configured the task to mount the EFS volume using UID 1001, which is the default UID for sbt-native-packager Docker containers, but in fact, Scala Steward current runs as root (#3283). While looking into the issue, we noticed that the article titled Running scala-steward periodically on AWS Fargate no longer exists, so this PR also removes that link from the documentation. (Hopefully we'll be able to publish some details about how we're running Scala Steward using Fargate as a replacement!)