Highly opinionated fork of the Lightbend Akka gRPC G8 template.
Out of the box, it provides:
- Fully functional Akka gRPC service
- Access log (HTTP based)
- Basic GitHub Actions workflow
- Setup for structured logging
- Basic healthcheck
- Customized build.sbt
- Scalafmt setup
- Docker image creation and publishing support
- Always latest stable releases of required dependencies
- Support for code coverage
- Scalafix linter and rules
- ScalaSteward setup (with Pull Request auto-merge)
Prerequisites:
- JDK 11+
- sbt 1.13.13+
Assuming that you have access to the private repository, in the console, type:
sbt new git@github.com:umatrangolo/akka-grpc-quickstart-scala.g8.gitThis template will prompt for a set of parameters asking for the desired versions of all the dependencies; you can just press enter on the proposed choices given that they are the latest stable versions found on the Maven repository.
However, these are the ones that you will need to fill correctly:
| Name | Description |
|---|---|
| name | Becomes the name of the project (e.g. foo-svc) |
| description | Used to bootstrap README.md for the app |
| organization | The organization owning this app (e.g. example) |
| codeowners | Content of the GitHub CODEOWNERS file |
| package | Starting package (e.g. foo.bar) |
| docker_maintainer | Email of the maintainer of this app |
| docker_package_name | Specifies the package name for Docker (e.g. gonitro/foo-svc) |
The generated service is runnable out of the box. To start locally:
sbt run
that listens on port 9000 and answering on a simple healthcheck.
grpcurl --insecure localhost:9000 grpc.health.v1.Health/Check
The template will use GitHub actions to implement a basic CI/CD pipeline.
We have three different pipelines with their jobs:
- CI
- lint: lints your code (e.g. checks formatting)
- test: compiles and runs tests checking also for coverage
- Scala Steward
- scala-steward: each Sunday it opens a lot of PRs proposing dependencies updates (that will be auto-merged on a green build)