Skip to content

Commit ef49e22

Browse files
authored
Merge pull request #683 from cchantep/patch-2
Update run documentation
2 parents 3e253ca + 4162d99 commit ef49e22

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

docs/running.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ sbt stage
1515
--env-var FOO=BAR
1616
```
1717

18-
Or,
18+
> If [Firejail](https://firejail.wordpress.com/) is not available locally, the option `--disable-sandbox` can be used (not recommanded for production environment).
19+
20+
Or as a [Docker](https://www.docker.com/) container:
1921

2022
```bash
2123
sbt docker:publishLocal
@@ -32,7 +34,17 @@ docker run -v $STEWARD_DIR:/opt/scala-steward -it scala-steward:0.1.0-SNAPSHOT \
3234
--env-var FOO=BAR
3335
```
3436

35-
If you run Scala Steward for your own private projects, you can pass additional environment variables from the command line using the `--env-var` flag as shown in the examples above. You can use this to pass any credentials required by your projects to resolve any private dependencies, e.g.:
37+
The [`git-ask-pass` option](https://git-scm.com/docs/gitcredentials) must specify an executable file (script) that returns (on the stdout),
38+
39+
- either the plain text password corresponding to the configured `${LOGIN}`,
40+
- or (recommanded) an authentication token corresponding to `${LOGIN}` (with appropriate permissions to watch the repositories; e.g. [Create a personal access token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line) for GitHub).
41+
42+
### Private repositories
43+
44+
If you run Scala Steward for your own private projects, the option `--do-not-fork` can be required, not to fork.
45+
Instead it will create pull requests directly on the private repository (as soon as the `${LOGIN}` can).
46+
47+
It can also be useful to pass additional environment variables from the command line using the `--env-var` flag as shown in the examples above. You can use this to pass any credentials required by your projects to resolve any private dependencies, e.g.:
3648

3749
```bash
3850
--env-var BINTRAY_USER=username \

0 commit comments

Comments
 (0)