Instructions on how to run manually for private project?

[Daenyth]

I'd like to use this on my company's codebase to help save maintenance time. Is that possible?

[fthomas]

Yes, this should be easy with a small code change. Here is what you'd need to do:

1. change githubLegacy.myLogin in githubLegacy.scala to the login of the user you want to use to create PRs
2. create a file ~/.github/tokens/$myLogin with a GitHub access token for the user myLogin
3. make sure curl, firejail, git, and sbt are installed
4. update repos.md
5. run sbt core/run periodically

If you try this, let me know if it works. And I'm open to make this whole process as easy as possible.

[fthomas]

One thing I forgot: change the committer name and email in gitLegacy.setUserSteward to the name and email of your bot account. This is not critical but it would be strange if @scala-steward would be a committer in your private repos.

It would be nice if we could at some point configure these with PureConfig.

[fthomas]

There is now a Config class that contains all the things one wants to change when running Scala steward.

[Philippus]

I tried this out. By default a fork is made of the project under the specified username, for our setup cloning and then raising the PR directly would be preferred.
I also got a 422 Unprocessable Entity after the Create PR-step, not sure what could be the cause of that.

[fthomas]

@Philippus Thanks for your feedback! Creating PRs without forking only works if the bot account has write access to the repos it updates, right? So it is unlikely that I'll implement this myself since I'm only operating Scala steward for public repos for which the bot has no write access.
I haven't seen that 422 Unprocessable Entity error before. Is a PR actually created or does this error happen before creating a PR?

[fthomas]

Note that #148 changed how the GiHub password / access token is passed to Git. The configuration of a token file has been replaced by an askpass program that Git invokes to retrieve the password.

[fthomas]

#161 allows to pass configuration parameters as command-line options. So scala-steward does not need to be recompiled to change the configuration.

[nafg]

What about just running it on a local project on my laptop? Specifically the logic that modifies the .sbt files.

[fthomas]

scala-steward is not designed to run on single projects. I think the best option here would be to create some kind of sbt-steward plugin that shares the logic for modifying source files with scala-steward. If you'd like to work on this, I could create appropriate repos at https://github.com/scala-steward-org

[nafg]

How coupled is the code right now? If the code is refactored so that part is easy to move out, I could see myself doing it one day...

…

On Fri, Feb 1, 2019, 3:15 PM Frank S. Thomas ***@***.***> wrote: scala-steward is not designed to run on single projects. I think the best option here would be to create some kind of sbt-steward plugin that shares the logic for modifying source files with scala-steward. If you'd like to work on this, I could create appropriate repos at https://github.com/scala-steward-org — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#48 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAGAUFKoQ-ZGfpQCev1WlLnMVgKojVdXks5vJKBPgaJpZM4W4s4w> .

[fthomas]

I'd say it is already easy to move that part out. All the logic that modifies source code is currently in Update.replaceAllIn.

[blast-hardcheese]

It seems as though

create a file ~/.github/tokens/$myLogin with a GitHub access token for the user myLogin

is no longer required as well

[blast-hardcheese]

I'm starting to attempt to run this against our internal GHE repos -- two issues:

1. Attempting to run scala-steward outside of docker in OSX produces:

2019-02-02 06:17:48,379 INFO  Add global sbt plugins
2019-02-02 06:17:48,531 INFO  Clean workspace /opt/docker/workspace
0
2019-02-02 06:17:48,866 INFO  ──────────── Total time: run: 532ms ────────────
2019-02-02 06:17:48,895 INFO  Shutting down connection pool: curAllocated=0 idleQueues.size=0 waitQueue.size=0 maxWaitQueueLimit=256 closed=false

2. Attempting to run the docker instructions from README.md yields:

docker: Error response from daemon: OCI runtime create failed: container_linux.go:348: starting container process caused "exec: \"/opt/docker/bin/scala-steward\": stat /opt/docker/bin/scala-steward: no such file or directory": unknown.

because we're -v $STEWARD_DIR:/opt/dockering
Modifying the command to

docker run \
  -v $STEWARD_DIR/workspace:/opt/docker/workspace \
  -v $STEWARD_DIR/misc:/opt/docker/misc \
  -v $STEWARD_DIR/.github:/opt/docker/.github \
  -it scala-steward:0.1.0-SNAPSHOT \
  --workspace  "/opt/docker/workspace" \
  --repos-file "/opt/docker/misc/repos.md" \
  --git-author-name "Scala steward" \
  --git-author-email ${EMAIL} \
  --github-api-host "${GITHUB_HOST}" \
  --github-login ${LOGIN} \
  --git-ask-pass "/opt/docker/.github/askpass/$LOGIN.sh"

gets us back to

2019-02-02 06:21:07,489 INFO  Add global sbt plugins
2019-02-02 06:21:07,613 INFO  Clean workspace /opt/docker/workspace
0
2019-02-02 06:21:07,939 INFO  ──────────── Total time: run: 478ms ────────────
2019-02-02 06:21:07,957 INFO  Shutting down connection pool: curAllocated=0 idleQueues.size=0 waitQueue.size=0 maxWaitQueueLimit=256 closed=false

[blast-hardcheese]

Oh, of course. I missed the leading - in the repos.md. Now I'm just getting 302, continuing to debug.

[blast-hardcheese]

Ah, and the last issue was my GITHUB_HOST variable was incorrect (left off the /v3/api suffix). Everything is working great now, I'll open a PR with the alterations to the docker run command

[tjheslin1]

I believe I'm having the same issue. @blast-hardcheese looking forward to your README update!

[cchantep]

Hi, first thx for this great tool. I would be interested to understand how this would work with private repos, specially how would it fork? Is there any plan so that the PR would be push directly on the original repo (w/ appropriate permissions) ?

[fthomas]

@cchantep You have two options.

1. Use a user with appropriate permissions to read and fork you repos.
2. Use a user that has permissions to create pull requests in your repos and run with --do-not-fork (Add configuration to disable forking #208) so that repos are not forked and pull requests are directly created in the target repositories.

[ChristopherDavenport]

We use a repo with a git submodule to avoid repo interactions.

[cchantep]

Thx @fthomas, second option seems fine for private enterprise repos.

[cchantep]

Have create a PR with some suggestion for the related documentation.

BTW is there any way/plan to support repository where SBT is not setup at the root of the repo?

[fthomas]

@cchantep #678 should also take care of repositories where the build is not in the root directory.

[fthomas]

Fixed by #683.