Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update run documentation #683

Merged
merged 2 commits into from
Jul 10, 2019
Merged

Update run documentation #683

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d335df8
Update run documentation
cchantep Jul 10, 2019
4162d99
Update running.md
cchantep Jul 10, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions docs/running.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ sbt stage
--env-var FOO=BAR
```

Or,
> If [Firejail](https://firejail.wordpress.com/) is not available locally, the option `--disable-sandbox` can be used (not recommanded for production environment).

Or as a [Docker](https://www.docker.com/) container:

```bash
sbt docker:publishLocal
Expand All @@ -32,11 +34,21 @@ docker run -v $STEWARD_DIR:/opt/scala-steward -it scala-steward:0.1.0-SNAPSHOT \
--env-var FOO=BAR
```

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.:
The [`git-ask-pass` option](https://git-scm.com/docs/gitcredentials) must specify an executable file (script) that returns (on the stdout),

- either the plain text password corresponding to the configured `${LOGIN}`,
- 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).

### Private repositories

If you run Scala Steward for your own private projects, the option `--do-not-fork` can be required, not to fork.
Instead it will create pull requests directly on the private repository (as soon as the `${LOGIN}` can).

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

```bash
--env-var BINTRAY_USER=username \
--env-var BINTRAY_PASS=password
```

These variables will be accessible (in sbt) to all of the projects that Scala Steward checks dependencies for.
These variables will be accessible (in SBT) to all of the projects that Scala Steward checks dependencies for.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should just be sbt. :-)

Suggested change
These variables will be accessible (in SBT) to all of the projects that Scala Steward checks dependencies for.
These variables will be accessible (in sbt) to all of the projects that Scala Steward checks dependencies for.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Weird naming ... updated