LukaJCB / scala-steward

:robot: A robot that helps you keeping your Scala projects up-to-date

scala-steward

scala-steward is a robot that helps you keeping library dependencies and sbt plugins up-to-date.

Quick start guide

Open a pull request that adds the GitHub repository of your Scala project to repos.md. Once that PR is merged, @scala-steward will check periodically for updates of libraries and plugins in your project and will open pull requests in your repository if it can figure out where version numbers need to be updated.

Show us the pull requests!

If you are curious how @scala-steward's pull requests look like, here are the ones it has created so far:

• Created pull requests (compact view)
• Merged pull requests (compact view)

Contributors

The following people have helped making scala-steward great:

• Arulselvan Madhavan
• Filipe Regadas
• Frank S. Thomas
• kenji yoshida
• Piotr Gabara
• Zelenya
• Your name here :-)

Participation

The scala-steward project supports the Scala Code of Conduct and wants all of its channels (GitHub, Gitter, etc.) to be welcoming environments for everyone.

Credit

scala-steward wouldn't exist without the great sbt-updates plugin to determine dependency updates and a bunch of Typelevel and other Scala libraries.

@scala-steward's cute profile picture is by @impurepics.

Running scala-steward

sbt stage

./modules/core/.jvm/target/universal/stage/bin/scala-steward \
  --workspace  "$STEWARD_DIR/workspace" \
  --repos-file "$STEWARD_DIR/repos.md" \
  --git-author-name "Scala steward" \
  --git-author-email ${EMAIL} \
  --github-api-host "https://api.github.com" \
  --github-login ${LOGIN} \
  --git-ask-pass "$STEWARD_DIR/.github/askpass/$LOGIN.sh" \
  --sign-commits

Or,

sbt docker:publishLocal

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

License

scala-steward is licensed under the Apache License, Version 2.0.