1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
[](https://travis-ci.org/drivergroup/sbt-settings)
[](https://index.scala-lang.org/drivergroup/sbt-settings)
# _sbt_ plugin for common _sbt_ settings
Provides common Driver Scala projects configuration for sbt, Scala compiler, testing, linting, formatting, release process, packaging, publication. Allows to use only necessary parts. Sets artifact `organization` to `xyz.driver`.
## Getting started
### project/plugins.sbt
addSbtPlugin("xyz.driver" % "sbt-settings" % "<latest_tag>")
### build.sbt
There are two different ways to use the `sbt-settings` configuration:
* As a "Service" — deployed application distributed as a Docker container. Includes Driver Inc.'s artifactory settings, Docker packaging with truststore configuration, build info generation. Versioned using `version.sbt` file for major and minor versions. Usage example, as follows
```
lazy val root = (project in file("."))
.driverService ("Name-Of-Your-Service")
.integrationTestingConfiguration // Enable integration tests
.packagingConfiguration // To package to zip file as java server app
.settings(lintingSettings) // Scala code linting settings
.settings(formatSettings) // Standard Scala code formatting
.settings(releaseSettings(ServiceReleaseProcess)) // Release process configuration
```
* As a "Library" — commonly used code, distributed as jar using artifactory. Versioned using git tag-based versioning. Includes Driver Inc.'s artifactory settings, publication to artifactory, `sbt release` settings,
```
lazy val root = (project in file("."))
.driverLibrary("Name-Of-Your-Library")
.settings(lintingSettings ++ formatSettings)
```
Do `sbt reload` after adding a plugin and changing project configuration.
## Reference
Artifact organization is set to `xyz.driver`.
### Scala compiler settings
Scala version — 2.12, flags configured:
- Common settings: `-unchecked -feature -encoding utf8`,
- _Advanced Scala features_: `-language:higherKinds -language:implicitConversions -language:postfixOps -language:reflectiveCalls`,
- _Compiler linting_: `-Xlint -deprecation -Ywarn-numeric-widen -Ywarn-dead-code -Ywarn-unused -Ywarn-unused-import -Xfatal-warnings -Xlint:-missing-interpolator`.
### Used sbt plugins
- [sbt-scalafmt](https://olafurpg.github.io/scalafmt/) - code formatter for Scala,
- [scalastyle-sbt-plugin](https://github.com/scalastyle) - examines your Scala code and indicates potential problems with it,
- [sbt-revolver](https://github.com/spray/sbt-revolver) - for dangerously fast development turnaround in Scala,
- [sbt-buildinfo](https://github.com/sbt/sbt-buildinfo) - generates Scala source from your build definitions,
- [sbt-git](https://github.com/sbt/sbt-git) - to get access to git data (commit hash, branch) in sbt,
- [sbt-native-packager](https://github.com/sbt/sbt-native-packager) - build application packages in native formats,
- [sbt-assembly](https://github.com/sbt/sbt-assembly) - deploy fat JARs. Restart processes (sbt-native-packager is used instead,)
- [sbt-release](https://github.com/sbt/sbt-release) - customizable release process,
- [sbt-docker](https://github.com/marcuslonnberg/sbt-docker) - create Docker images directly from sbt.
## Developing
This project is set up to auto-deploy on push. If an annotated tag in
the form `v<digit>.*` is pushed, a new version of this project will be
built and published to Maven Central.
|
