Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/geirolz/sbt-service-info

A small companion of sbt-buildinfo to add more service-specific informations.
https://github.com/geirolz/sbt-service-info

information sbt sbt-plugin scala

Last synced: 24 days ago
JSON representation

A small companion of sbt-buildinfo to add more service-specific informations.

Host: GitHub
URL: https://github.com/geirolz/sbt-service-info
Owner: geirolz
License: apache-2.0
Created: 2022-12-22T16:43:44.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-09-08T00:32:16.000Z (2 months ago)
Last Synced: 2024-09-08T01:35:35.773Z (2 months ago)
Topics: information, sbt, sbt-plugin, scala
Language: Scala
Homepage:
Size: 61.5 KB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS

Awesome Lists containing this project

README

## SBT Service Info

[![CICD](https://github.com/geirolz/sbt-service-info/actions/workflows/cicd.yml/badge.svg)](https://github.com/geirolz/sbt-service-info/actions/workflows/cicd.yml)
[![Scala Steward](https://img.shields.io/badge/Scala_Steward-helping-blue.svg?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAQCAMAAAARSr4IAAAAVFBMVEUAAACHjojlOy5NWlrKzcYRKjGFjIbp293YycuLa3pYY2LSqql4f3pCUFTgSjNodYRmcXUsPD/NTTbjRS+2jomhgnzNc223cGvZS0HaSD0XLjbaSjElhIr+AAAAAXRSTlMAQObYZgAAAHlJREFUCNdNyosOwyAIhWHAQS1Vt7a77/3fcxxdmv0xwmckutAR1nkm4ggbyEcg/wWmlGLDAA3oL50xi6fk5ffZ3E2E3QfZDCcCN2YtbEWZt+Drc6u6rlqv7Uk0LdKqqr5rk2UCRXOk0vmQKGfc94nOJyQjouF9H/wCc9gECEYfONoAAAAASUVORK5CYII=)](https://gitlab.com/moneyfarm-tech/sandbox/steward)
[![Mergify Status](https://img.shields.io/endpoint.svg?url=https://gh.mergify.io/badges/geirolz/sbt-service-info&style=flat)](https://mergify.io)

This plugin adds custom keys to [sbt-buildinfo](https://github.com/sbt/sbt-buildinfo) to have more information about the microservice.
Settings are typed to improve readability and consistency.

## How to use
Add this to your project `plugins.sbt` file
```sbt
addSbtPlugin("com.github.geirolz" % "sbt-service-info" % "0.0.1")
```

And then enable the plugin to your project in the `build.sbt` file with
```sbt
lazy val myProject = (project in file("."))
.enablePlugins(BuildInfoPlugin, ServiceInfoPlugin)
```

## Keys
- `serviceBoundedContext` = Specify service bounded context info, default `unknown`.
- `serviceProcessingPurpose` = Specify service processing purpose, can be `OLTP` or `OLAP` default `unknown`.
- `serviceTags` = Specify service useful tags, default `Nil`
- `serviceTagsIncludeDependencies` = Boolean to specify if automatic add tags related to service dependencies or not, default `true`.
- `serviceTagsIncludeDependenciesVersions` = When `serviceTagsIncludeDependencies` is true this flag specify if add dependencies version in the tags or not, default `true`

## N.B.
In your `build.sbt` file where you declare yours `buildInfoKeys` mind to use `++=` instead of `:=`.
Otherwise, the keys set by this plugin will be overloaded by yours

Example
```sbt
buildInfoKeys ++= List[BuildInfoKey](
name,
description,
version,
scalaVersion,
sbtVersion,
buildInfoBuildNumber
)
```