Skip to content

Commit 2edbcca

Browse files
committed
add a note to the documentation about the owner of the workspace directory
1 parent 5a416a2 commit 2edbcca

File tree

2 files changed

+20
-2
lines changed

2 files changed

+20
-2
lines changed

docs/running.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,16 @@ More information about using the `--scalafix-migrations` and `--artifact-migrati
5151
The workspace directory (specified with `--workspace`) provides a location for cache and temporary files.
5252

5353
It is important to persist this workspace between runs. Without this, Scala Steward will be unable to observe
54-
repo-specific preferences (such as [pullRequests.frequency](repo-specific-configuration.md)) correctly.
54+
repo-specific preferences (such as [pullRequests.frequency](repo-specific-configuration.md)) correctly.
55+
56+
Furthermore, `git` requires the workspace directory to be owned by the same user that will run Scala Steward.
57+
If there is an ownership mismatch, `git` may print error messages like
58+
59+
> fatal: detected dubious ownership in repository …
60+
61+
or
62+
63+
> fatal: not in a git directory
5564
5665
### Private repositories
5766

modules/docs/mdoc/running.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,16 @@ More information about using the `--scalafix-migrations` and `--artifact-migrati
5151
The workspace directory (specified with `--workspace`) provides a location for cache and temporary files.
5252

5353
It is important to persist this workspace between runs. Without this, Scala Steward will be unable to observe
54-
repo-specific preferences (such as [pullRequests.frequency](repo-specific-configuration.md)) correctly.
54+
repo-specific preferences (such as [pullRequests.frequency](repo-specific-configuration.md)) correctly.
55+
56+
Furthermore, `git` requires the workspace directory to be owned by the same user that will run Scala Steward.
57+
If there is an ownership mismatch, `git` may print error messages like
58+
59+
> fatal: detected dubious ownership in repository …
60+
61+
or
62+
63+
> fatal: not in a git directory
5564
5665
### Private repositories
5766

0 commit comments

Comments
 (0)