Ciris v0.8.0
This release arrives with a much rewritten and expanded usage guide. (#116)
Some of the notable changes to the usage guide include the following.
- Most references to types and functions are now hyperlinked to the API documentation.
- Usage Basics includes guidance on when configuration files are appropriate, and when configuration as code is a better fit. Working with configuration values is covered in more detail, and there is a section on suspending effects.
- Encoding Validation covers refined types in greater depth, including useable configurations and external libraries.
- Multiple Environments better explains when to use
withValues
(andwithValue
) and how to deal with different values, and different configuration loading, across environments, while eliminating duplicated configuration values. - Logging Configurations shows how to use
Secret
for avoiding logging secret configuration values. There is also a section on how to useShow
from cats together with kittens, for improved configuration logging overtoString
. - Configuration sources and source transformations are covered in more detail, including current supported sources.
- There is a new section on how to support new sources, including a detailed example of supporting property files.
- Configuration decoders are covered in more detail, including current supported types and supporting new types.
- The modules overview has been split into separate pages.
Changes
- Add
orNone
function onConfigValue
for optional fallback values. (#107)
The updated usage guide provides more details on configuration values.env[ApiKey]("API_KEY") .orElse(prop[ApiKey]("api.key")) .orNone
- Add cats-effect
suspendMemoizeF
syntax forConfigSource
. (#110)
The usage guide has more information on source transformations. - Add
ConfigDecoder[String, scala.util.matching.Regex]
. (#111)
The usage guide provides a list of all the current supported types. - Fix
BigDecimal
decoding using fixed precision on Scala 2.10. (#111) - Add support for decoding
yes
/no
andon
/off
Boolean
values. (#111)
The usage guide provides a list of all the current supported types. - Remove unnecessary
Show[Id[A]]
derivation causing ambiguous implicits. (#112)
The usage guide explains howShow
can be used for logging configurations. - Improve the error message for combined configuration errors. (#106)
- Try scripts no longer shadow other libraries' namespaces. (#114)
Updates
Released on 2018-03-11.