CoursierConfigModule

mill.scalalib.CoursierConfigModule
See theCoursierConfigModule companion trait
@Scaladoc(value = "/**\n * Reads coursier environment variables and Java properties\n *\n * This module reads environment variables and Java properties, and uses\n * them to get default values for a number of coursier parameters, such as:\n *\n * * the coursier cache location, read from `COURSIER_CACHE` in the environment\n * and `coursier.cache` in Java properties. It is recommended to use an\n * absolute path rather than a relative one.\n *\n * * the coursier archive cache location, read from `COURSIER_ARCHIVE_CACHE` in\n * the environment and in `coursier.archive.cache` in Java properties.\n *\n * * credentials, read from `COURSIER_CREDENTIALS` in the environment, and\n * `coursier.credentials` in Java properties. Its format is documented\n * here: https://github.com/coursier/coursier/blob/701e93664855709db38e443cb7a19e36ddc49b78/doc/docs/other-credentials.md\n *\n * * TTL for snapshot artifacts / version listings / etc., read from\n * `COURSIER_TTL` in the environment and `coursier.ttl` in Java properties.\n * This value is parsed with `scala.concurrent.duration.Duration`, and accepts\n * formats like \"5 hours\", \"1 day\", etc. or just \"0\".\n *\n * * default repositories, read from `COURSIER_REPOSITORIES` in the environment\n * and `coursier.repositories` in Java properties. It can be set to values like\n * \"ivy2Local|central|https://maven.google.com\". Its format is documented here:\n * https://github.com/coursier/coursier/blob/701e93664855709db38e443cb7a19e36ddc49b78/doc/docs/other-repositories.md\n *\n * * mirror repository files, read from `COURSIER_MIRRORS` and `coursier.mirrors`,\n * whose file they point to should contains things like\n *\n * google.from=https://repo1.maven.org/maven2\n * google.to=https://maven.google.com\n *\n * Environment variables always have precedence over Java properties.\n */")

Reads coursier environment variables and Java properties

This module reads environment variables and Java properties, and uses them to get default values for a number of coursier parameters, such as:

Environment variables always have precedence over Java properties.

Attributes

Companion
trait
Source
CoursierConfigModule.scala
Graph
Supertypes
class BaseModule
trait Module
trait ModuleApi
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Self type

Members list

Type members

Inherited classlikes

@Scaladoc(value = "/**\n * Miscellaneous machinery around traversing & querying the build hierarchy,\n * that should not be needed by normal users of Mill\n */")
object moduleInternal extends Internal

Miscellaneous machinery around traversing & querying the build hierarchy, that should not be needed by normal users of Mill

Miscellaneous machinery around traversing & querying the build hierarchy, that should not be needed by normal users of Mill

Attributes

Inherited from:
Module
Source
Module.scala
Supertypes
class Internal
class Object
trait Matchable
class Any

Value members

Inherited methods

@Scaladoc(value = "/**\n * Aggregates coursier parameters read from the environment\n */")

Aggregates coursier parameters read from the environment

Aggregates coursier parameters read from the environment

Attributes

Inherited from:
CoursierConfigModule
Source
CoursierConfigModule.scala
@Scaladoc(value = "/**\n * Environment variables and Java properties, and their values, used by coursier\n */")
def coursierEnv: Simple[(env: Map[String, String], props: Map[String, String])]

Environment variables and Java properties, and their values, used by coursier

Environment variables and Java properties, and their values, used by coursier

Attributes

Inherited from:
CoursierConfigModule
Source
CoursierConfigModule.scala
@Scaladoc(value = "/**\n * Default archive cache location to be used by coursier\n *\n * This is the directory under which archives are unpacked\n * by `coursier.cache.ArchiveCache`. This includes JVMs\n * managed by coursier, which Mill relies on by default.\n */")

Default archive cache location to be used by coursier

Default archive cache location to be used by coursier

This is the directory under which archives are unpacked by coursier.cache.ArchiveCache. This includes JVMs managed by coursier, which Mill relies on by default.

Attributes

Inherited from:
CoursierConfigModule
Source
CoursierConfigModule.scala
@Scaladoc(value = "/** Default cache location to be used by coursier */")
def defaultCacheLocation: Task[String]

Default cache location to be used by coursier

Default cache location to be used by coursier

Attributes

Inherited from:
CoursierConfigModule
Source
CoursierConfigModule.scala
@Scaladoc(value = "/** Default cache policies used by coursier when downloading artifacts */")
def defaultCachePolicies: Task[Seq[CachePolicy]]

Default cache policies used by coursier when downloading artifacts

Default cache policies used by coursier when downloading artifacts

Attributes

Inherited from:
CoursierConfigModule
Source
CoursierConfigModule.scala
@Scaladoc(value = "/** Default JSON configuration files to be used by coursier */")

Default JSON configuration files to be used by coursier

Default JSON configuration files to be used by coursier

Attributes

Inherited from:
CoursierConfigModule
Source
CoursierConfigModule.scala
@Scaladoc(value = "/** Default repository credentials to be used by coursier */")
def defaultCredentials: Task[Seq[Credentials]]

Default repository credentials to be used by coursier

Default repository credentials to be used by coursier

Attributes

Inherited from:
CoursierConfigModule
Source
CoursierConfigModule.scala
@Scaladoc(value = "/** Default mirrors to be used by coursier */")
def defaultMirrors: Task[Seq[Mirror]]

Default mirrors to be used by coursier

Default mirrors to be used by coursier

Attributes

Inherited from:
CoursierConfigModule
Source
CoursierConfigModule.scala
@Scaladoc(value = "/** Default repositories for dependency resolution */")
def defaultRepositories: Task[Seq[Repository]]

Default repositories for dependency resolution

Default repositories for dependency resolution

Attributes

Inherited from:
CoursierConfigModule
Source
CoursierConfigModule.scala
@Scaladoc(value = "/** Default TTL used by coursier when downloading changing artifacts such as snapshots */")
def defaultTtl: Task[Option[Duration]]

Default TTL used by coursier when downloading changing artifacts such as snapshots

Default TTL used by coursier when downloading changing artifacts such as snapshots

Attributes

Inherited from:
CoursierConfigModule
Source
CoursierConfigModule.scala

Attributes

Inherited from:
BaseModule
Source
BaseModule.scala
def moduleDir: Path

Attributes

Inherited from:
Module
Source
Module.scala

Attributes

Inherited from:
Module
Source
Module.scala
override def moduleSegments: Segments

Attributes

Definition Classes
Inherited from:
ExternalModule
Source
ExternalModule.scala
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Module -> Any
Inherited from:
Module
Source
Module.scala

Concrete fields

Attributes

Source
CoursierConfigModule.scala