mill-contrib-bintray
API
Generated with
mill-contrib-bintray/mill.contrib.bintray/BintrayPublishModule

BintrayPublishModule

mill.contrib.bintray.BintrayPublishModule
See theBintrayPublishModule companion object
trait BintrayPublishModule extends PublishModule

Attributes

Companion
object
Graph
Supertypes
trait PublishModule
trait JavaModule
trait JavaModuleApi
trait AssemblyModule
trait SemanticDbJavaModule
trait SemanticDbJavaModuleApi
trait OfflineSupportModule
trait CoursierModule
trait GenIdeaModule
trait RunModule
trait RunModuleApi
trait TaskModule
trait JavaModuleBase
trait BspModule
trait BspModuleApi
trait WithJvmWorker
trait Module
trait ModuleApi
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all

Members list

Type members

Inherited classlikes

trait JavaTests extends JavaModule, TestModule

Attributes

Inherited from:
JavaModule
Supertypes
trait TestModule
trait TestModuleApi
trait JavaModule
trait JavaModuleApi
trait AssemblyModule
trait SemanticDbJavaModule
trait SemanticDbJavaModuleApi
trait OfflineSupportModule
trait CoursierModule
trait GenIdeaModule
trait RunModule
trait RunModuleApi
trait TaskModule
trait JavaModuleBase
trait BspModule
trait BspModuleApi
trait WithJvmWorker
trait Module
trait ModuleApi
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
@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
Supertypes
class Internal
class Object
trait Matchable
class Any

Value members

Abstract methods

def bintrayOwner: String
def bintrayRepo: String

Concrete methods

def bintrayPackage: Target[String]
@Scaladoc(value = "/**\n * Publish all given artifacts to Bintray.\n * Uses environment variables BINTRAY_USERNAME and BINTRAY_PASSWORD as\n * credentials.\n *\n * @param credentials Bintray credentials in format username:password.\n * If specified, environment variables will be ignored.\n * Note: consider using environment variables over this argument due\n * to security reasons.\n */")
def publishBintray(credentials: String, bintrayOwner: String, bintrayRepo: String, release: Boolean, readTimeout: Int, connectTimeout: Int): Command[Unit]

Publish all given artifacts to Bintray. Uses environment variables BINTRAY_USERNAME and BINTRAY_PASSWORD as credentials.

Publish all given artifacts to Bintray. Uses environment variables BINTRAY_USERNAME and BINTRAY_PASSWORD as credentials.

Value parameters

credentials

Bintray credentials in format username:password. If specified, environment variables will be ignored. Note: consider using environment variables over this argument due to security reasons.

Attributes

Inherited methods

def allBomDeps: Task[Seq[BomDependency]]

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * All main classes detected in this module that can serve as program entry-points.\n */")
def allLocalMainClasses: Target[Seq[String]]

All main classes detected in this module that can serve as program entry-points.

All main classes detected in this module that can serve as program entry-points.

Attributes

Inherited from:
RunModule
@Scaladoc(value = "/**\n * Aggregation of mandatoryMvnDeps and mvnDeps.\n * In most cases, instead of overriding this Target you want to override `mvnDeps` instead.\n */")
def allMvnDeps: Target[Seq[Dep]]

Aggregation of mandatoryMvnDeps and mvnDeps. In most cases, instead of overriding this Target you want to override mvnDeps instead.

Aggregation of mandatoryMvnDeps and mvnDeps. In most cases, instead of overriding this Target you want to override mvnDeps instead.

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * The repositories used to resolve dependencies\n *\n * Unlike [[repositoriesTask]], this includes the Mill internal repositories,\n * which allow to resolve Mill internal modules (usually brought in via\n * `JavaModule#coursierDependency`).\n *\n * Beware that this needs to evaluate `JavaModule#coursierProject` of all\n * module dependencies of the current module, which itself evaluates `JavaModule#mvnDeps`\n * and related tasks. You shouldn\'t depend on this task from implementations of `mvnDeps`,\n * which would introduce cycles between Mill tasks.\n */")
def allRepositories: Task[Seq[Repository]]

The repositories used to resolve dependencies

The repositories used to resolve dependencies

Unlike repositoriesTask, this includes the Mill internal repositories, which allow to resolve Mill internal modules (usually brought in via JavaModule#coursierDependency).

Beware that this needs to evaluate JavaModule#coursierProject of all module dependencies of the current module, which itself evaluates JavaModule#mvnDeps and related tasks. You shouldn't depend on this task from implementations of mvnDeps, which would introduce cycles between Mill tasks.

Attributes

Inherited from:
CoursierModule
@Scaladoc(value = "/**\n * All individual source files fed into the Java compiler\n */")
def allSourceFiles: Target[Seq[PathRef]]

All individual source files fed into the Java compiler

All individual source files fed into the Java compiler

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * The folders containing all source files fed into the compiler\n */")
def allSources: Target[Seq[PathRef]]

The folders containing all source files fed into the compiler

The folders containing all source files fed into the compiler

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * The exact id of the artifact to be published. You probably don\'t want to override this.\n * If you want to customize the name of the artifact, override artifactName instead.\n * If you want to customize the scala version in the artifact id, see ScalaModule.artifactScalaVersion\n */")
def artifactId: Target[String]

The exact id of the artifact to be published. You probably don't want to override this. If you want to customize the name of the artifact, override artifactName instead. If you want to customize the scala version in the artifact id, see ScalaModule.artifactScalaVersion

The exact id of the artifact to be published. You probably don't want to override this. If you want to customize the name of the artifact, override artifactName instead. If you want to customize the scala version in the artifact id, see ScalaModule.artifactScalaVersion

Attributes

Inherited from:
JavaModule
def artifactMetadata: Target[Artifact]

Attributes

Inherited from:
PublishModule
@Scaladoc(value = "/**\n * Override this to change the published artifact id.\n * For example, by default a scala module foo.baz might be published as foo-baz_2.12 and a java module would be foo-baz.\n * Setting this to baz would result in a scala artifact baz_2.12 or a java artifact baz.\n */")
def artifactName: Target[String]

Override this to change the published artifact id. For example, by default a scala module foo.baz might be published as foo-baz_2.12 and a java module would be foo-baz. Setting this to baz would result in a scala artifact baz_2.12 or a java artifact baz.

Override this to change the published artifact id. For example, by default a scala module foo.baz might be published as foo-baz_2.12 and a java module would be foo-baz. Setting this to baz would result in a scala artifact baz_2.12 or a java artifact baz.

Attributes

Inherited from:
JavaModule
def artifactNameParts: Target[Seq[String]]

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * The suffix appended to the artifact IDs during publishing\n */")
def artifactSuffix: Target[String]

The suffix appended to the artifact IDs during publishing

The suffix appended to the artifact IDs during publishing

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Default artifact types to fetch and put in the classpath. Add extra types\n * here if you\'d like fancy artifact extensions to be fetched.\n */")
def artifactTypes: Target[Set[Type]]

Default artifact types to fetch and put in the classpath. Add extra types here if you'd like fancy artifact extensions to be fetched.

Default artifact types to fetch and put in the classpath. Add extra types here if you'd like fancy artifact extensions to be fetched.

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * An executable uber-jar/assembly containing all the resources and compiled\n * classfiles from this module and all it\'s upstream modules and dependencies\n */")
def assembly: Target[PathRef]

An executable uber-jar/assembly containing all the resources and compiled classfiles from this module and all it's upstream modules and dependencies

An executable uber-jar/assembly containing all the resources and compiled classfiles from this module and all it's upstream modules and dependencies

Attributes

Inherited from:
AssemblyModule
@Scaladoc(value = "/**\n * Configuration for the [[assembly]] task: how files and file-conflicts are\n * managed when combining multiple jar files into one big assembly jar.\n */")
def assemblyRules: Seq[Rule]

Configuration for the assembly task: how files and file-conflicts are managed when combining multiple jar files into one big assembly jar.

Configuration for the assembly task: how files and file-conflicts are managed when combining multiple jar files into one big assembly jar.

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Bind a dependency ([[Dep]]) to the actual module context (e.g. the scala version and the platform suffix)\n * @return The [[BoundDep]]\n */")
def bindDependency: Task[Dep => BoundDep]

Bind a dependency (Dep) to the actual module context (e.g. the scala version and the platform suffix)

Bind a dependency (Dep) to the actual module context (e.g. the scala version and the platform suffix)

Attributes

Returns

The BoundDep

Inherited from:
CoursierModule
override def bomModuleDeps: Seq[BomModule & PublishModule]

Bill of Material (BOM) dependencies of this module. This is meant to be overridden to add BOM dependencies. To read the value, you should use bomModuleDepsChecked instead, which uses a cached result which is also checked to be free of cycles.

Bill of Material (BOM) dependencies of this module. This is meant to be overridden to add BOM dependencies. To read the value, you should use bomModuleDepsChecked instead, which uses a cached result which is also checked to be free of cycles.

Attributes

See also

bomModuleDepsChecked

Definition Classes
PublishModule -> JavaModule
Inherited from:
PublishModule
@Scaladoc(value = "/**\n * Same as [[bomModuleDeps]] but checked to not contain cycles.\n * Prefer this over using [[bomModuleDeps]] directly.\n */")
final def bomModuleDepsChecked: Seq[BomModule]

Same as bomModuleDeps but checked to not contain cycles. Prefer this over using bomModuleDeps directly.

Same as bomModuleDeps but checked to not contain cycles. Prefer this over using bomModuleDeps directly.

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Any Bill of Material (BOM) dependencies you want to add to this Module, in the format\n * mvn\"org:name:version\"\n */")
def bomMvnDeps: Target[Seq[Dep]]

Any Bill of Material (BOM) dependencies you want to add to this Module, in the format mvn"org:name:version"

Any Bill of Material (BOM) dependencies you want to add to this Module, in the format mvn"org:name:version"

Attributes

Inherited from:
JavaModule
override def bspBuildTarget: BspBuildTarget

Use to fill most fields of BuildTarget.

Use to fill most fields of BuildTarget.

Attributes

Definition Classes
JavaModule -> SemanticDbJavaModule -> BspModule -> BspModuleApi
Inherited from:
JavaModule
override def bspBuildTargetData: Task[Option[(String, AnyRef)]]

Use to populate the BuildTarget.{dataKind,data} fields.

Use to populate the BuildTarget.{dataKind,data} fields.

Mill specific implementations:

  • JvmBuildTarget
  • ScalaBuildTarget

Attributes

Definition Classes
JavaModule -> BspModule -> BspModuleApi
Inherited from:
JavaModule
def classgraphWorkerModule: ModuleRef[ClassgraphWorkerModule]

Attributes

Inherited from:
RunModule
@Scaladoc(value = "/**\n * Compiles the current module to generate compiled classfiles/bytecode.\n *\n * When you override this, you probably also want/need to override [[bspCompileClassesPath]],\n * as that needs to point to the same compilation output path.\n *\n * Keep in sync with [[bspCompileClassesPath]]\n */")
def compile: Target[CompilationResult]

Compiles the current module to generate compiled classfiles/bytecode.

Compiles the current module to generate compiled classfiles/bytecode.

When you override this, you probably also want/need to override bspCompileClassesPath, as that needs to point to the same compilation output path.

Keep in sync with bspCompileClassesPath

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * All classfiles and resources from upstream modules and dependencies\n * necessary to compile this module.\n *\n * Keep in sync with [[bspCompileClasspath]]\n */")
def compileClasspath: Target[Seq[PathRef]]

All classfiles and resources from upstream modules and dependencies necessary to compile this module.

All classfiles and resources from upstream modules and dependencies necessary to compile this module.

Keep in sync with bspCompileClasspath

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * The compile-only direct dependencies of this module. These are *not*\n * transitive, and only take effect in the module that they are declared in.\n */")
def compileModuleDeps: Seq[JavaModule]

The compile-only direct dependencies of this module. These are not transitive, and only take effect in the module that they are declared in.

The compile-only direct dependencies of this module. These are not transitive, and only take effect in the module that they are declared in.

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/** Same as [[compileModuleDeps]] but checked to not contain cycles. */")
final def compileModuleDepsChecked: Seq[JavaModule]

Same as compileModuleDeps but checked to not contain cycles.

Same as compileModuleDeps but checked to not contain cycles.

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Same as `mvnDeps`, but only present at compile time. Useful for e.g.\n * macro-related dependencies like `scala-reflect` that doesn\'t need to be\n * present at runtime\n */")
def compileMvnDeps: Target[Seq[Dep]]

Same as mvnDeps, but only present at compile time. Useful for e.g. macro-related dependencies like scala-reflect that doesn't need to be present at runtime

Same as mvnDeps, but only present at compile time. Useful for e.g. macro-related dependencies like scala-reflect that doesn't need to be present at runtime

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * The folders where the compile time resource files for this module live.\n * If your resources files do not necessarily need to be seen by the compiler,\n * you should use [[resources]] instead.\n */")
def compileResources: Target[Seq[PathRef]]

The folders where the compile time resource files for this module live. If your resources files do not necessarily need to be seen by the compiler, you should use resources instead.

The folders where the compile time resource files for this module live. If your resources files do not necessarily need to be seen by the compiler, you should use resources instead.

Attributes

Inherited from:
JavaModule
def compiledClassesAndSemanticDbFiles: Target[PathRef]

Attributes

Inherited from:
SemanticDbJavaModule
@Scaladoc(value = "/**\n * Customize the coursier file cache.\n *\n * This is rarely needed to be changed, but sometimes e.g. you want to load a coursier plugin.\n * Doing so requires adding to coursier\'s classpath. To do this you could use the following:\n * {{{\n * override def coursierCacheCustomizer = Task.Anon {\n * Some( (fc: coursier.cache.FileCache[Task]) =>\n * fc.withClassLoaders(Seq(classOf[coursier.cache.protocol.S3Handler].getClassLoader))\n * )\n * }\n * }}}\n * @return\n */")
def coursierCacheCustomizer: Task[Option[FileCache[Task] => FileCache[Task]]]

Customize the coursier file cache.

Customize the coursier file cache.

This is rarely needed to be changed, but sometimes e.g. you want to load a coursier plugin. Doing so requires adding to coursier's classpath. To do this you could use the following:

 override def coursierCacheCustomizer = Task.Anon {
    Some( (fc: coursier.cache.FileCache[Task]) =>
      fc.withClassLoaders(Seq(classOf[coursier.cache.protocol.S3Handler].getClassLoader))
    )
 }

Attributes

Inherited from:
CoursierModule
@Scaladoc(value = "/**\n * The `coursier.Dependency` to use to refer to this module\n */")
def coursierDependency: Dependency

The coursier.Dependency to use to refer to this module

The coursier.Dependency to use to refer to this module

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * The `coursier.Project` corresponding to this `JavaModule`.\n *\n * This provides details about this module to the coursier resolver (details such as\n * dependencies, BOM dependencies, dependency management, etc.). Beyond more general\n * resolution parameters (such as artifact types, etc.), this should be the only way\n * we provide details about this module to coursier.\n */")
def coursierProject: Task[Project]

The coursier.Project corresponding to this JavaModule.

The coursier.Project corresponding to this JavaModule.

This provides details about this module to the coursier resolver (details such as dependencies, BOM dependencies, dependency management, etc.). Beyond more general resolution parameters (such as artifact types, etc.), this should be the only way we provide details about this module to coursier.

Attributes

Inherited from:
JavaModule
def defaultCommandName(): String

The name of the default command, which will be automatically executed if the module name is provided at the Mill command line.

The name of the default command, which will be automatically executed if the module name is provided at the Mill command line.

Attributes

Inherited from:
JavaModule
def defaultPublishInfos: Target[Seq[PublishInfo]]

Attributes

Inherited from:
PublishModule
@Scaladoc(value = "/**\n * A `CoursierModule.Resolver` to resolve dependencies.\n *\n * Can be used to resolve external dependencies, if you need to download an external\n * tool from Maven or Ivy repositories, by calling `CoursierModule.Resolver#classpath`.\n *\n * @return `CoursierModule.Resolver` instance\n */")
def defaultResolver: Task[Resolver]

A CoursierModule.Resolver to resolve dependencies.

A CoursierModule.Resolver to resolve dependencies.

Can be used to resolve external dependencies, if you need to download an external tool from Maven or Ivy repositories, by calling CoursierModule.Resolver#classpath.

Attributes

Returns

CoursierModule.Resolver instance

Inherited from:
CoursierModule
@Scaladoc(value = "/**\n * Dependency management data\n *\n * Versions and exclusions in dependency management override those of transitive dependencies,\n * while they have no effect if the corresponding dependency isn\'t pulled during dependency\n * resolution.\n *\n * For example, the following forces com.lihaoyi::os-lib to version 0.11.3, and\n * excludes org.slf4j:slf4j-api from com.lihaoyi::cask that it forces to version 0.9.4\n * {{{\n * def depManagement = super.depManagement() ++ Seq(\n * mvn\"com.lihaoyi::os-lib:0.11.3\",\n * mvn\"com.lihaoyi::cask:0.9.5\".exclude(\"org.slf4j\", \"slf4j-api\")\n * )\n * }}}\n */")
def depManagement: Target[Seq[Dep]]

Dependency management data

Dependency management data

Versions and exclusions in dependency management override those of transitive dependencies, while they have no effect if the corresponding dependency isn't pulled during dependency resolution.

For example, the following forces com.lihaoyi::os-lib to version 0.11.3, and excludes org.slf4j:slf4j-api from com.lihaoyi::cask that it forces to version 0.9.4

 def depManagement = super.depManagement() ++ Seq(
   mvn"com.lihaoyi::os-lib:0.11.3",
   mvn"com.lihaoyi::cask:0.9.5".exclude("org.slf4j", "slf4j-api")
 )

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * The documentation jar, containing all the Javadoc/Scaladoc HTML files, for\n * publishing to Maven Central\n */")
def docJar: Target[PathRef]

The documentation jar, containing all the Javadoc/Scaladoc HTML files, for publishing to Maven Central

The documentation jar, containing all the Javadoc/Scaladoc HTML files, for publishing to Maven Central

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Control whether `docJar`-target should use a file to pass command line arguments to the javadoc tool.\n * Defaults to `true` on Windows.\n * Beware: Using an args-file is probably not supported for very old javadoc versions.\n */")
def docJarUseArgsFile: Target[Boolean]

Control whether docJar-target should use a file to pass command line arguments to the javadoc tool. Defaults to true on Windows. Beware: Using an args-file is probably not supported for very old javadoc versions.

Control whether docJar-target should use a file to pass command line arguments to the javadoc tool. Defaults to true on Windows. Beware: Using an args-file is probably not supported for very old javadoc versions.

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Extra directories to be copied into the documentation.\n *\n * Typically, includes static files such as html and markdown, but depends\n * on the doc tool that is actually used.\n * @see [[docSources]]\n */")
def docResources: Target[Seq[PathRef]]

Extra directories to be copied into the documentation.

Extra directories to be copied into the documentation.

Typically, includes static files such as html and markdown, but depends on the doc tool that is actually used.

Attributes

See also

docSources

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Directories to be processed by the API documentation tool.\n *\n * Typically, includes the source files to generate documentation from.\n * @see [[docResources]]\n */")
def docSources: Target[Seq[PathRef]]

Directories to be processed by the API documentation tool.

Directories to be processed by the API documentation tool.

Typically, includes the source files to generate documentation from.

Attributes

See also

docResources

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Extra artifacts to publish.\n */")
def extraPublish: Target[Seq[PublishInfo]]

Extra artifacts to publish.

Extra artifacts to publish.

Attributes

Inherited from:
PublishModule
def finalMainClass: Target[String]

Attributes

Inherited from:
RunModule
def finalMainClassOpt: Target[Either[String, String]]

Attributes

Inherited from:
RunModule
@Scaladoc(value = "/**\n * Any command-line parameters you want to pass to the forked JVM.\n */")
def forkArgs: Target[Seq[String]]

Any command-line parameters you want to pass to the forked JVM.

Any command-line parameters you want to pass to the forked JVM.

Attributes

Inherited from:
RunModule
@Scaladoc(value = "/**\n * Similar to `forkArgs` but only applies to the `bat` launcher script\n */")
def forkCmdArgs: Target[Seq[String]]

Similar to forkArgs but only applies to the bat launcher script

Similar to forkArgs but only applies to the bat launcher script

Attributes

Inherited from:
AssemblyModule
@Scaladoc(value = "/**\n * Any environment variables you want to pass to the forked JVM.\n */")
def forkEnv: Target[Map[String, String]]

Any environment variables you want to pass to the forked JVM.

Any environment variables you want to pass to the forked JVM.

Attributes

Inherited from:
RunModule
@Scaladoc(value = "/**\n * Similar to `forkArgs` but only applies to the `sh` launcher script\n */")
def forkShellArgs: Target[Seq[String]]

Similar to forkArgs but only applies to the sh launcher script

Similar to forkArgs but only applies to the sh launcher script

Attributes

Inherited from:
AssemblyModule
def forkWorkingDir: Target[Path]

Attributes

Inherited from:
RunModule
@Scaladoc(value = "/**\n * Folders containing source files that are generated rather than\n * handwritten; these files can be generated in this target itself,\n * or can refer to files generated from other targets\n */")
def generatedSources: Target[Seq[PathRef]]

Folders containing source files that are generated rather than handwritten; these files can be generated in this target itself, or can refer to files generated from other targets

Folders containing source files that are generated rather than handwritten; these files can be generated in this target itself, or can refer to files generated from other targets

Attributes

Inherited from:
JavaModule
def ideaCompileOutput: Target[PathRef]

Attributes

Inherited from:
GenIdeaModule
@Scaladoc(value = "/**\n * Contribute components to idea config files.\n */")
def ideaConfigFiles(ideaConfigVersion: Int): Task[Seq[IdeaConfigFile]]

Contribute components to idea config files.

Contribute components to idea config files.

Attributes

Inherited from:
GenIdeaModule
@Scaladoc(value = "/**\n * Contribute facets to the Java module configuration.\n * @param ideaConfigVersion The IDEA configuration version in use. Probably `4`.\n * @return\n */")
def ideaJavaModuleFacets(ideaConfigVersion: Int): Task[Seq[JavaFacet]]

Contribute facets to the Java module configuration.

Contribute facets to the Java module configuration.

Value parameters

ideaConfigVersion

The IDEA configuration version in use. Probably 4.

Attributes

Inherited from:
GenIdeaModule
def intellijModulePath: Path

Attributes

Inherited from:
GenIdeaModule
def intellijModulePathJava: Path

Attributes

Inherited from:
GenIdeaModule
@Scaladoc(value = "/**\n * The repository that knows about this project itself and its module dependencies\n */")
def internalDependenciesRepository: Task[Repository]

The repository that knows about this project itself and its module dependencies

The repository that knows about this project itself and its module dependencies

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Path to the ivy.xml file for this module\n */")
def ivy: Target[PathRef]

Path to the ivy.xml file for this module

Path to the ivy.xml file for this module

Attributes

Inherited from:
PublishModule
@Scaladoc(value = "/**\n * A jar containing only this module\'s resources and compiled classfiles,\n * without those from upstream modules and dependencies\n */")
def jar: Target[PathRef]

A jar containing only this module's resources and compiled classfiles, without those from upstream modules and dependencies

A jar containing only this module's resources and compiled classfiles, without those from upstream modules and dependencies

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Options to pass to the java compiler\n */")
def javacOptions: Target[Seq[String]]

Options to pass to the java compiler

Options to pass to the java compiler

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Additional options to be used by the javadoc tool.\n * You should not set the `-d` setting for specifying the target directory,\n * as that is done in the [[docJar]] target.\n */")
def javadocOptions: Target[Seq[String]]

Additional options to be used by the javadoc tool. You should not set the -d setting for specifying the target directory, as that is done in the docJar target.

Additional options to be used by the javadoc tool. You should not set the -d setting for specifying the target directory, as that is done in the docJar target.

Attributes

Inherited from:
JavaModule
override def jvmWorker: ModuleRef[JvmWorkerModule]

Attributes

Definition Classes
JavaModule -> SemanticDbJavaModule -> WithJvmWorker
Inherited from:
JavaModule
def launcher: Target[PathRef]

Builds a command-line "launcher" file that can be used to run this module's code, without the Mill process. Useful for deployment & other places where you do not want a build tool running

Builds a command-line "launcher" file that can be used to run this module's code, without the Mill process. Useful for deployment & other places where you do not want a build tool running

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * The *output* classfiles/resources from this module, used for execution,\n * excluding upstream modules and third-party dependencies, but including unmanaged dependencies.\n *\n * This is build from [[localCompileClasspath]] and [[localRunClasspath]]\n * as the parts available \"before compilation\" and \"after compilation\".\n *\n * Keep in sync with [[bspLocalClasspath]]\n */")
def localClasspath: Target[Seq[PathRef]]

The output classfiles/resources from this module, used for execution, excluding upstream modules and third-party dependencies, but including unmanaged dependencies.

The output classfiles/resources from this module, used for execution, excluding upstream modules and third-party dependencies, but including unmanaged dependencies.

This is build from localCompileClasspath and localRunClasspath as the parts available "before compilation" and "after compilation".

Keep in sync with bspLocalClasspath

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * The *input* classfiles/resources from this module, used during compilation,\n * excluding upstream modules and third-party dependencies\n */")
def localCompileClasspath: Target[Seq[PathRef]]

The input classfiles/resources from this module, used during compilation, excluding upstream modules and third-party dependencies

The input classfiles/resources from this module, used during compilation, excluding upstream modules and third-party dependencies

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * The part of the [[localClasspath]] which is available \"after compilation\".\n *\n * Keep in sync with [[bspLocalRunClasspath]]\n */")
override def localRunClasspath: Target[Seq[PathRef]]

The part of the localClasspath which is available "after compilation".

The part of the localClasspath which is available "after compilation".

Keep in sync with bspLocalRunClasspath

Attributes

Definition Classes
JavaModule -> RunModule
Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Allows you to specify an explicit main class to use for the `run` command.\n * If none is specified, the classpath is searched for an appropriate main\n * class to use if one exists.\n */")
def mainClass: Target[Option[String]]

Allows you to specify an explicit main class to use for the run command. If none is specified, the classpath is searched for an appropriate main class to use if one exists.

Allows you to specify an explicit main class to use for the run command. If none is specified, the classpath is searched for an appropriate main class to use if one exists.

Attributes

Inherited from:
RunModule
@Scaladoc(value = "/**\n * Additional options for the java compiler derived from other module settings.\n */")
def mandatoryJavacOptions: Target[Seq[String]]

Additional options for the java compiler derived from other module settings.

Additional options for the java compiler derived from other module settings.

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Mandatory ivy dependencies that are typically always required and shouldn\'t be removed by\n * overriding [[mvnDeps]], e.g. the scala-library in the [[ScalaModule]].\n */")
def mandatoryMvnDeps: Target[Seq[Dep]]

Mandatory ivy dependencies that are typically always required and shouldn't be removed by overriding mvnDeps, e.g. the scala-library in the ScalaModule.

Mandatory ivy dependencies that are typically always required and shouldn't be removed by overriding mvnDeps, e.g. the scala-library in the ScalaModule.

Attributes

Inherited from:
JavaModule
override def manifest: Target[JarManifest]

Creates a manifest representation which can be modified or replaced The default implementation just adds the Manifest-Version, Main-Class and Created-By attributes

Creates a manifest representation which can be modified or replaced The default implementation just adds the Manifest-Version, Main-Class and Created-By attributes

Attributes

Definition Classes
PublishModule -> AssemblyModule
Inherited from:
PublishModule
@Scaladoc(value = "/**\n * Map dependencies before resolving them.\n * Override this to customize the set of dependencies.\n */")
def mapDependencies: Task[Dependency => Dependency]

Map dependencies before resolving them. Override this to customize the set of dependencies.

Map dependencies before resolving them. Override this to customize the set of dependencies.

Attributes

Inherited from:
CoursierModule
@Scaladoc(value = "/**\n * A [[CoursierModule.Resolver]] to resolve dependencies.\n *\n * Unlike [[defaultResolver]], this resolver can resolve Mill modules too\n * (obtained via [[JavaModule.coursierDependency]]).\n *\n * @return `CoursierModule.Resolver` instance\n */")
def millResolver: Task[Resolver]

A CoursierModule.Resolver to resolve dependencies.

A CoursierModule.Resolver to resolve dependencies.

Unlike defaultResolver, this resolver can resolve Mill modules too (obtained via JavaModule.coursierDependency).

Attributes

Returns

CoursierModule.Resolver instance

Inherited from:
CoursierModule
def moduleCtx: ModuleCtx

Attributes

Inherited from:
BaseClass
override def moduleDeps: Seq[PublishModule]

The direct dependencies of this module. This is meant to be overridden to add dependencies. To read the value, you should use moduleDepsChecked instead, which uses a cached result which is also checked to be free of cycle.

The direct dependencies of this module. This is meant to be overridden to add dependencies. To read the value, you should use moduleDepsChecked instead, which uses a cached result which is also checked to be free of cycle.

Attributes

See also

moduleDepschecked

Definition Classes
PublishModule -> JavaModule
Inherited from:
PublishModule
@Scaladoc(value = "/**\n * Same as [[moduleDeps]] but checked to not contain cycles.\n * Prefer this over using [[moduleDeps]] directly.\n */")
final def moduleDepsChecked: Seq[JavaModule]

Same as moduleDeps but checked to not contain cycles. Prefer this over using moduleDeps directly.

Same as moduleDeps but checked to not contain cycles. Prefer this over using moduleDeps directly.

Attributes

Inherited from:
JavaModule
def moduleDir: Path

Attributes

Inherited from:
Module
def moduleDirJava: Path

Attributes

Inherited from:
Module
def moduleDirectChildren: Seq[Module]

Attributes

Inherited from:
Module
def moduleSegments: Segments

Attributes

Inherited from:
Module
@Scaladoc(value = "/**\n * Any ivy dependencies you want to add to this Module, in the format\n * mvn\"org::name:version\" for Scala dependencies or mvn\"org:name:version\"\n * for Java dependencies\n */")
def mvnDeps: Target[Seq[Dep]]

Any ivy dependencies you want to add to this Module, in the format mvn"org::name:version" for Scala dependencies or mvn"org:name:version" for Java dependencies

Any ivy dependencies you want to add to this Module, in the format mvn"org::name:version" for Scala dependencies or mvn"org:name:version" for Java dependencies

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Command to print the transitive dependency tree to STDOUT.\n */")
def mvnDepsTree(args: MvnDepsTreeArgs): Command[Unit]

Command to print the transitive dependency tree to STDOUT.

Command to print the transitive dependency tree to STDOUT.

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * What platform suffix to use for publishing, e.g. `_sjs` for Scala.js\n * projects\n */")
def platformSuffix: Target[String]

What platform suffix to use for publishing, e.g. _sjs for Scala.js projects

What platform suffix to use for publishing, e.g. _sjs for Scala.js projects

Attributes

Inherited from:
JavaModule
def pom: Target[PathRef]

Attributes

Inherited from:
PublishModule
@Scaladoc(value = "/**\n * The packaging type. See [[PackagingType]] for specially handled values.\n */")
def pomPackagingType: String

The packaging type. See PackagingType for specially handled values.

The packaging type. See PackagingType for specially handled values.

Attributes

Inherited from:
PublishModule
@Scaladoc(value = "/**\n * POM parent project.\n *\n * @see [[https://maven.apache.org/guides/introduction/introduction-to-the-pom.html#Project_Inheritance Project Inheritance]]\n */")
def pomParentProject: Target[Option[Artifact]]

POM parent project.

POM parent project.

Attributes

See also
Inherited from:
PublishModule
@Scaladoc(value = "/**\n * @param all If `true` fetches also source dependencies\n */")
override def prepareOffline(all: Flag): Command[Unit]

Value parameters

all

If true fetches also source dependencies

Attributes

Definition Classes
JavaModule -> OfflineSupportModule
Inherited from:
JavaModule
@Scaladoc(value = "/**\n * What shell script to use to launch the executable generated by `assembly`.\n * Defaults to a generic \"universal\" launcher that should work for Windows,\n * OS-X and Linux\n */")
def prependShellScript: Target[String]

What shell script to use to launch the executable generated by assembly. Defaults to a generic "universal" launcher that should work for Windows, OS-X and Linux

What shell script to use to launch the executable generated by assembly. Defaults to a generic "universal" launcher that should work for Windows, OS-X and Linux

Attributes

Inherited from:
AssemblyModule
@Scaladoc(value = "/**\n * Publish all given artifacts to Sonatype.\n * Uses environment variables MILL_SONATYPE_USERNAME and MILL_SONATYPE_PASSWORD as\n * credentials.\n *\n * @param sonatypeCreds Sonatype credentials in format username:password.\n * If specified, environment variables will be ignored.\n * Note: consider using environment variables over this argument due\n * to security reasons.\n * @param gpgArgs GPG arguments. Defaults to `--batch --yes -a -b`.\n * Specifying this will override/remove the defaults.\n * Add the default args to your args to keep them.\n */")
def publish(sonatypeCreds: String, signed: Boolean, gpgArgs: Seq[String], release: Boolean, readTimeout: Int, connectTimeout: Int, awaitTimeout: Int, stagingRelease: Boolean): Command[Unit]

Publish all given artifacts to Sonatype. Uses environment variables MILL_SONATYPE_USERNAME and MILL_SONATYPE_PASSWORD as credentials.

Publish all given artifacts to Sonatype. Uses environment variables MILL_SONATYPE_USERNAME and MILL_SONATYPE_PASSWORD as credentials.

Value parameters

gpgArgs

GPG arguments. Defaults to --batch --yes -a -b. Specifying this will override/remove the defaults. Add the default args to your args to keep them.

sonatypeCreds

Sonatype credentials in format username:password. If specified, environment variables will be ignored. Note: consider using environment variables over this argument due to security reasons.

Attributes

Inherited from:
PublishModule
def publishArtifacts: Target[PublishData]

Attributes

Inherited from:
PublishModule
def publishLocal(localIvyRepo: String): Command[Unit]

Attributes

Inherited from:
PublishModule
@Scaladoc(value = "/**\n * Publish artifacts to a local ivy repository.\n * @param localIvyRepo The local ivy repository.\n * If not defined, the default resolution is used (probably `$HOME/.ivy2/local`).\n * @param sources whether to generate and publish a sources JAR\n * @param doc whether to generate and publish a javadoc JAR\n * @param transitive if true, also publish locally the transitive module dependencies of this module\n * (this includes the runtime transitive module dependencies, but not the compile-only ones)\n */")
def publishLocal(localIvyRepo: String, sources: Boolean, doc: Boolean, transitive: Boolean): Command[Unit]

Publish artifacts to a local ivy repository.

Publish artifacts to a local ivy repository.

Value parameters

doc

whether to generate and publish a javadoc JAR

localIvyRepo

The local ivy repository. If not defined, the default resolution is used (probably $HOME/.ivy2/local).

sources

whether to generate and publish a sources JAR

transitive

if true, also publish locally the transitive module dependencies of this module (this includes the runtime transitive module dependencies, but not the compile-only ones)

Attributes

Inherited from:
PublishModule
@Scaladoc(value = "/**\n * Publish artifacts the local ivy repository.\n */")
def publishLocalCached: Target[Seq[PathRef]]

Publish artifacts the local ivy repository.

Publish artifacts the local ivy repository.

Attributes

Inherited from:
PublishModule
@Scaladoc(value = "/**\n * Publish artifacts to a local Maven repository.\n * @param m2RepoPath The path to the local repository as string (default: `$HOME/.m2repository`).\n * If not set, falls back to `maven.repo.local` system property or `~/.m2/repository`\n * @return [[PathRef]]s to published files.\n */")
def publishM2Local(m2RepoPath: String): Command[Seq[PathRef]]

Publish artifacts to a local Maven repository.

Publish artifacts to a local Maven repository.

Value parameters

m2RepoPath

The path to the local repository as string (default: $HOME/.m2repository). If not set, falls back to maven.repo.local system property or ~/.m2/repository

Attributes

Returns

PathRefs to published files.

Inherited from:
PublishModule
@Scaladoc(value = "/**\n * Publish artifacts to the local Maven repository.\n * @return [[PathRef]]s to published files.\n */")
def publishM2LocalCached: Target[Seq[PathRef]]

Publish artifacts to the local Maven repository.

Publish artifacts to the local Maven repository.

Attributes

Returns

PathRefs to published files.

Inherited from:
PublishModule
@Scaladoc(value = "/**\n * The default path that [[publishM2Local]] should publish its artifacts to.\n * Defaults to `~/.m2/repository`, but can be configured by setting the\n * `maven.repo.local` JVM property\n */")
def publishM2LocalRepoPath: Task[Path]

The default path that publishM2Local should publish its artifacts to. Defaults to ~/.m2/repository, but can be configured by setting the maven.repo.local JVM property

The default path that publishM2Local should publish its artifacts to. Defaults to ~/.m2/repository, but can be configured by setting the maven.repo.local JVM property

Attributes

Inherited from:
PublishModule
def publishMvnDeps: Task[(Map[Module, String], Map) => Seq[Dependency]]

Attributes

Inherited from:
PublishModule
@Scaladoc(value = "/**\n * Properties to be published with the published pom/ivy XML.\n * Use `super.publishProperties() ++` when overriding to avoid losing default properties.\n * @since Mill after 0.10.0-M5\n */")
def publishProperties: Target[Map[String, String]]

Properties to be published with the published pom/ivy XML. Use super.publishProperties() ++ when overriding to avoid losing default properties.

Properties to be published with the published pom/ivy XML. Use super.publishProperties() ++ when overriding to avoid losing default properties.

Attributes

Since

Mill after 0.10.0-M5

Inherited from:
PublishModule
def publishSelfDependency: Target[Artifact]

Attributes

Inherited from:
PublishModule
@Scaladoc(value = "/**\n * BOM dependency to specify in the POM\n */")
def publishXmlBomDeps: Task[Seq[Dependency]]

BOM dependency to specify in the POM

BOM dependency to specify in the POM

Attributes

Inherited from:
PublishModule
@Scaladoc(value = "/**\n * Dependency management to specify in the POM\n */")
def publishXmlDepMgmt: Task[Seq[Dependency]]

Dependency management to specify in the POM

Dependency management to specify in the POM

Attributes

Inherited from:
PublishModule
def publishXmlDeps: Task[Seq[Dependency]]

Attributes

Inherited from:
PublishModule
@Scaladoc(value = "/** The direct and indirect dependencies of this module */")
def recursiveModuleDeps: Seq[JavaModule]

The direct and indirect dependencies of this module

The direct and indirect dependencies of this module

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/** The direct and indirect runtime module dependencies of this module */")
def recursiveRunModuleDeps: Seq[JavaModule]

The direct and indirect runtime module dependencies of this module

The direct and indirect runtime module dependencies of this module

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * The repositories used to resolve dependencies with [[classpath()]].\n *\n * See [[allRepositories]] if you need to resolve Mill internal modules.\n */")
def repositoriesTask: Task[Seq[Repository]]

The repositories used to resolve dependencies with classpath().

The repositories used to resolve dependencies with classpath().

See allRepositories if you need to resolve Mill internal modules.

Attributes

Inherited from:
CoursierModule
@Scaladoc(value = "/**\n * Customize the coursier resolution process.\n * This is rarely needed to changed, as the default try to provide a\n * highly reproducible resolution process. But sometime, you need\n * more control, e.g. you want to add some OS or JDK specific resolution properties\n * which are sometimes used by Maven and therefore found in dependency artifact metadata.\n * For example, the JavaFX artifacts are known to use OS specific properties.\n * To fix resolution for JavaFX, you could override this task like the following:\n * {{{\n * override def resolutionCustomizer = Task.Anon {\n * Some( (r: coursier.core.Resolution) =>\n * r.withOsInfo(coursier.core.Activation.Os.fromProperties(sys.props.toMap))\n * )\n * }\n * }}}\n * @return\n */")
def resolutionCustomizer: Task[Option[Resolution => Resolution]]

Customize the coursier resolution process. This is rarely needed to changed, as the default try to provide a highly reproducible resolution process. But sometime, you need more control, e.g. you want to add some OS or JDK specific resolution properties which are sometimes used by Maven and therefore found in dependency artifact metadata. For example, the JavaFX artifacts are known to use OS specific properties. To fix resolution for JavaFX, you could override this task like the following:

Customize the coursier resolution process. This is rarely needed to changed, as the default try to provide a highly reproducible resolution process. But sometime, you need more control, e.g. you want to add some OS or JDK specific resolution properties which are sometimes used by Maven and therefore found in dependency artifact metadata. For example, the JavaFX artifacts are known to use OS specific properties. To fix resolution for JavaFX, you could override this task like the following:

   override def resolutionCustomizer = Task.Anon {
     Some( (r: coursier.core.Resolution) =>
       r.withOsInfo(coursier.core.Activation.Os.fromProperties(sys.props.toMap))
     )
   }

Attributes

Inherited from:
CoursierModule
@Scaladoc(value = "/**\n * Resolution parameters, allowing to customize resolution internals\n *\n * This rarely needs to be changed. This allows to disable the new way coursier handles\n * BOMs since coursier 2.1.17 (used in Mill since 0.12.3) for example, with:\n * {{{\n * def resolutionParams = super.resolutionParams()\n * .withEnableDependencyOverrides(Some(false))\n * }}}\n *\n * Note that versions forced with `Dep#forceVersion()` take over forced versions manually\n * set in `resolutionParams`. The former should be favored to force versions in dependency\n * resolution.\n *\n * The Scala version set via `ScalaModule#scalaVersion` also takes over any Scala version\n * provided via `ResolutionParams#scalaVersionOpt`.\n *\n * The default configuration set in `ResolutionParams#defaultConfiguration` is ignored when\n * Mill fetches dependencies to be passed to the compiler (equivalent to Maven \"compile scope\").\n * In that case, it forces the default configuration to be \"compile\". On the other hand, when\n * fetching dependencies for runtime (equivalent to Maven \"runtime scope\"), the value in\n * `ResolutionParams#defaultConfiguration` is used.\n */")
def resolutionParams: Task[ResolutionParams]

Resolution parameters, allowing to customize resolution internals

Resolution parameters, allowing to customize resolution internals

This rarely needs to be changed. This allows to disable the new way coursier handles BOMs since coursier 2.1.17 (used in Mill since 0.12.3) for example, with:

 def resolutionParams = super.resolutionParams()
   .withEnableDependencyOverrides(Some(false))

Note that versions forced with Dep#forceVersion() take over forced versions manually set in resolutionParams. The former should be favored to force versions in dependency resolution.

The Scala version set via ScalaModule#scalaVersion also takes over any Scala version provided via ResolutionParams#scalaVersionOpt.

The default configuration set in ResolutionParams#defaultConfiguration is ignored when Mill fetches dependencies to be passed to the compiler (equivalent to Maven "compile scope"). In that case, it forces the default configuration to be "compile". On the other hand, when fetching dependencies for runtime (equivalent to Maven "runtime scope"), the value in ResolutionParams#defaultConfiguration is used.

Attributes

Inherited from:
CoursierModule
def resolvePublishDependency: Task[Dep => Dependency]

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Build the assembly for third-party dependencies separate from the current\n * classpath\n *\n * This should allow much faster assembly creation in the common case where\n * third-party dependencies do not change\n */")
def resolvedIvyAssembly: Target[Assembly]

Build the assembly for third-party dependencies separate from the current classpath

Build the assembly for third-party dependencies separate from the current classpath

This should allow much faster assembly creation in the common case where third-party dependencies do not change

Attributes

Inherited from:
AssemblyModule
@Scaladoc(value = "/**\n * Resolved dependencies\n */")
def resolvedMvnDeps: Target[Seq[PathRef]]

Resolved dependencies

Resolved dependencies

Attributes

Inherited from:
JavaModule
def resolvedRunMvnDeps: Target[Seq[PathRef]]

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * The folders where the resource files for this module live.\n * If you need resources to be seen by the compiler, use [[compileResources]].\n */")
def resources: Target[Seq[PathRef]]

The folders where the resource files for this module live. If you need resources to be seen by the compiler, use compileResources.

The folders where the resource files for this module live. If you need resources to be seen by the compiler, use compileResources.

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Runs this module\'s code in a subprocess and waits for it to finish\n */")
def run(args: Task[Args]): Command[Unit]

Runs this module's code in a subprocess and waits for it to finish

Runs this module's code in a subprocess and waits for it to finish

Attributes

Inherited from:
RunModule
@Scaladoc(value = "/**\n * Runs this module\'s code in a background process, until it dies or\n * `runBackground` is used again. This lets you continue using Mill while\n * the process is running in the background: editing files, compiling, and\n * only re-starting the background process when you\'re ready.\n *\n * You can also use `-w foo.runBackground` to make Mill watch for changes\n * and automatically recompile your code & restart the background process\n * when ready. This is useful when working on long-running server processes\n * that would otherwise run forever\n */")
def runBackground(args: String*): Command[Unit]

Runs this module's code in a background process, until it dies or runBackground is used again. This lets you continue using Mill while the process is running in the background: editing files, compiling, and only re-starting the background process when you're ready.

Runs this module's code in a background process, until it dies or runBackground is used again. This lets you continue using Mill while the process is running in the background: editing files, compiling, and only re-starting the background process when you're ready.

You can also use -w foo.runBackground to make Mill watch for changes and automatically recompile your code & restart the background process when ready. This is useful when working on long-running server processes that would otherwise run forever

Attributes

Inherited from:
RunModule
@Scaladoc(value = "/**\n * If true, stdout and stderr of the process executed by `runBackground`\n * or `runMainBackground` is sent to mill\'s stdout/stderr (which usually\n * flow to the console).\n *\n * If false, output will be directed to files `stdout.log` and `stderr.log`\n * in `runBackground.dest` (or `runMainBackground.dest`)\n */")
def runBackgroundLogToConsole: Boolean

If true, stdout and stderr of the process executed by runBackground or runMainBackground is sent to mill's stdout/stderr (which usually flow to the console).

If true, stdout and stderr of the process executed by runBackground or runMainBackground is sent to mill's stdout/stderr (which usually flow to the console).

If false, output will be directed to files stdout.log and stderr.log in runBackground.dest (or runMainBackground.dest)

Attributes

Inherited from:
RunModule
def runBackgroundRestartDelayMillis: Target[Int]

Attributes

Inherited from:
RunModule
def runBackgroundTask(mainClass: Task[String], args: Task[Args]): Task[Unit]

Attributes

Inherited from:
RunModule
@Scaladoc(value = "/**\n * All classfiles and resources from upstream modules and dependencies\n * necessary to run this module\'s code after compilation\n */")
override def runClasspath: Target[Seq[PathRef]]

All classfiles and resources from upstream modules and dependencies necessary to run this module's code after compilation

All classfiles and resources from upstream modules and dependencies necessary to run this module's code after compilation

Attributes

Definition Classes
JavaModule -> RunModule
Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Runs this module\'s code in a subprocess and waits for it to finish\n */")
def runForkedTask(mainClass: Task[String], args: Task[Args]): Task[Unit]

Runs this module's code in a subprocess and waits for it to finish

Runs this module's code in a subprocess and waits for it to finish

Attributes

Inherited from:
RunModule
@Scaladoc(value = "/**\n * Runs this module\'s code in-process within an isolated classloader. This is\n * faster than `run`, but in exchange you have less isolation between runs\n * since the code can dirty the parent Mill process and potentially leave it\n * in a bad state.\n */")
def runLocal(args: Task[Args]): Command[Unit]

Runs this module's code in-process within an isolated classloader. This is faster than run, but in exchange you have less isolation between runs since the code can dirty the parent Mill process and potentially leave it in a bad state.

Runs this module's code in-process within an isolated classloader. This is faster than run, but in exchange you have less isolation between runs since the code can dirty the parent Mill process and potentially leave it in a bad state.

Attributes

Inherited from:
RunModule
def runLocalTask(mainClass: Task[String], args: Task[Args]): Task[Unit]

Attributes

Inherited from:
RunModule
@Scaladoc(value = "/**\n * Same as `run`, but lets you specify a main class to run\n */")
def runMain(mainClass: String, args: String*): Command[Unit]

Same as run, but lets you specify a main class to run

Same as run, but lets you specify a main class to run

Attributes

Inherited from:
RunModule
@Scaladoc(value = "/**\n * Same as `runBackground`, but lets you specify a main class to run\n */")
def runMainBackground(mainClass: String, args: String*): Command[Unit]

Same as runBackground, but lets you specify a main class to run

Same as runBackground, but lets you specify a main class to run

Attributes

Inherited from:
RunModule
@Scaladoc(value = "/**\n * Same as `runLocal`, but lets you specify a main class to run\n */")
def runMainLocal(mainClass: String, args: String*): Command[Unit]

Same as runLocal, but lets you specify a main class to run

Same as runLocal, but lets you specify a main class to run

Attributes

Inherited from:
RunModule
@Scaladoc(value = "/**\n * The runtime-only direct dependencies of this module. These *are* transitive,\n * and so get propagated to downstream modules automatically\n */")
def runModuleDeps: Seq[JavaModule]

The runtime-only direct dependencies of this module. These are transitive, and so get propagated to downstream modules automatically

The runtime-only direct dependencies of this module. These are transitive, and so get propagated to downstream modules automatically

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Same as [[moduleDeps]] but checked to not contain cycles.\n * Prefer this over using [[moduleDeps]] directly.\n */")
final def runModuleDepsChecked: Seq[JavaModule]

Same as moduleDeps but checked to not contain cycles. Prefer this over using moduleDeps directly.

Same as moduleDeps but checked to not contain cycles. Prefer this over using moduleDeps directly.

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Additional dependencies, only present at runtime. Useful for e.g.\n * selecting different versions of a dependency to use at runtime after your\n * code has already been compiled.\n */")
def runMvnDeps: Target[Seq[Dep]]

Additional dependencies, only present at runtime. Useful for e.g. selecting different versions of a dependency to use at runtime after your code has already been compiled.

Additional dependencies, only present at runtime. Useful for e.g. selecting different versions of a dependency to use at runtime after your code has already been compiled.

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Control whether `run*`-targets should use an args file to pass command line args, if possible.\n */")
def runUseArgsFile: Target[Boolean]

Control whether run*-targets should use an args file to pass command line args, if possible.

Control whether run*-targets should use an args file to pass command line args, if possible.

Attributes

Inherited from:
RunModule
def runner: Task[Runner]

Attributes

Inherited from:
RunModule
def sanitizeUri(uri: PathRef): String

Attributes

Inherited from:
JavaModule
def sanitizeUri(uri: Path): String

Attributes

Inherited from:
JavaModule
def sanitizeUri(uri: String): String

Attributes

Inherited from:
JavaModule
def semanticDbData: Target[PathRef]

Attributes

Inherited from:
SemanticDbJavaModule
def semanticDbJavaVersion: Target[String]

Attributes

Inherited from:
SemanticDbJavaModule
def semanticDbScalaVersion: Target[String]

Attributes

Inherited from:
SemanticDbJavaModule
def semanticDbVersion: Target[String]

Attributes

Inherited from:
SemanticDbJavaModule
@Scaladoc(value = "/**\n * Show the module dependencies.\n * @param recursive If `true` include all recursive module dependencies, else only show direct dependencies.\n */")
def showModuleDeps(recursive: Boolean): Command[Unit]

Show the module dependencies.

Show the module dependencies.

Value parameters

recursive

If true include all recursive module dependencies, else only show direct dependencies.

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Skip Idea project file generation.\n */")
def skipIdea: Boolean

Skip Idea project file generation.

Skip Idea project file generation.

Attributes

Inherited from:
GenIdeaModule
def sonatypeSnapshotUri: String

Attributes

Inherited from:
PublishModule
def sonatypeUri: String

Attributes

Inherited from:
PublishModule
@Scaladoc(value = "/**\n * The source jar, containing only source code for publishing to Maven Central\n */")
def sourceJar: Target[PathRef]

The source jar, containing only source code for publishing to Maven Central

The source jar, containing only source code for publishing to Maven Central

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * The folders where the source files for this module live\n */")
def sources: Target[Seq[PathRef]]

The folders where the source files for this module live

The folders where the source files for this module live

Attributes

Inherited from:
JavaModule
def sourcesFolders: Seq[SubPath]

Attributes

Inherited from:
JavaModule
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
@Scaladoc(value = "/**\n * The transitive version of `compileClasspath`\n */")
def transitiveCompileClasspath: Target[Seq[PathRef]]

The transitive version of compileClasspath

The transitive version of compileClasspath

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Coursier project of this module and those of all its transitive module dependencies\n */")
def transitiveCoursierProjects: Task[Seq[Project]]

Coursier project of this module and those of all its transitive module dependencies

Coursier project of this module and those of all its transitive module dependencies

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Almost the same as [[transitiveLocalClasspath]], but using the [[jar]]s instead of [[localClasspath]].\n */")
def transitiveJars: Target[Seq[PathRef]]

Almost the same as transitiveLocalClasspath, but using the jars instead of localClasspath.

Almost the same as transitiveLocalClasspath, but using the jars instead of localClasspath.

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * The transitive version of `localClasspath`\n */")
def transitiveLocalClasspath: Target[Seq[PathRef]]

The transitive version of localClasspath

The transitive version of localClasspath

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * All direct and indirect module dependencies of this module, including\n * compile-only dependencies: basically the modules whose classpath are needed\n * at compile-time.\n *\n * Note that `compileModuleDeps` are defined to be non-transitive, so we only\n * look at the direct `compileModuleDeps` when assembling this list\n */")
def transitiveModuleCompileModuleDeps: Seq[JavaModule]

All direct and indirect module dependencies of this module, including compile-only dependencies: basically the modules whose classpath are needed at compile-time.

All direct and indirect module dependencies of this module, including compile-only dependencies: basically the modules whose classpath are needed at compile-time.

Note that compileModuleDeps are defined to be non-transitive, so we only look at the direct compileModuleDeps when assembling this list

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Like `recursiveModuleDeps` but also include the module itself,\n * basically the modules whose classpath are needed at runtime\n */")
def transitiveModuleDeps: Seq[JavaModule]

Like recursiveModuleDeps but also include the module itself, basically the modules whose classpath are needed at runtime

Like recursiveModuleDeps but also include the module itself, basically the modules whose classpath are needed at runtime

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * All direct and indirect module dependencies of this module, including\n * compile-only dependencies: basically the modules whose classpath are needed\n * at runtime.\n *\n * Note that `runModuleDeps` are defined to be transitive\n */")
def transitiveModuleRunModuleDeps: Seq[JavaModule]

All direct and indirect module dependencies of this module, including compile-only dependencies: basically the modules whose classpath are needed at runtime.

All direct and indirect module dependencies of this module, including compile-only dependencies: basically the modules whose classpath are needed at runtime.

Note that runModuleDeps are defined to be transitive

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Like `recursiveModuleDeps` but also include the module itself,\n * basically the modules whose classpath are needed at runtime\n */")
def transitiveRunModuleDeps: Seq[JavaModule]

Like recursiveModuleDeps but also include the module itself, basically the modules whose classpath are needed at runtime

Like recursiveModuleDeps but also include the module itself, basically the modules whose classpath are needed at runtime

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Additional jars, classfiles or resources to add to the classpath directly\n * from disk rather than being downloaded from Maven Central or other package\n * repositories\n */")
def unmanagedClasspath: Target[Seq[PathRef]]

Additional jars, classfiles or resources to add to the classpath directly from disk rather than being downloaded from Maven Central or other package repositories

Additional jars, classfiles or resources to add to the classpath directly from disk rather than being downloaded from Maven Central or other package repositories

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Build the assembly for upstream dependencies separate from the current\n * classpath\n *\n * This should allow much faster assembly creation in the common case where\n * upstream dependencies do not change\n */")
def upstreamAssembly: Target[Assembly]

Build the assembly for upstream dependencies separate from the current classpath

Build the assembly for upstream dependencies separate from the current classpath

This should allow much faster assembly creation in the common case where upstream dependencies do not change

Attributes

Inherited from:
AssemblyModule
@Scaladoc(value = "/**\n * All upstream classfiles and resources necessary to build and executable\n * assembly, but without this module\'s contribution\n */")
def upstreamAssemblyClasspath: Target[Seq[PathRef]]

All upstream classfiles and resources necessary to build and executable assembly, but without this module's contribution

All upstream classfiles and resources necessary to build and executable assembly, but without this module's contribution

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * The upstream compilation output of all this module\'s upstream modules\n */")
def upstreamCompileOutput: Target[Seq[CompilationResult]]

The upstream compilation output of all this module's upstream modules

The upstream compilation output of all this module's upstream modules

Attributes

Inherited from:
JavaModule
def upstreamIvyAssemblyClasspath: Target[Seq[PathRef]]

Upstream classfiles and resources from third-party libraries necessary to build an executable assembly

Upstream classfiles and resources from third-party libraries necessary to build an executable assembly

Attributes

Inherited from:
JavaModule
def upstreamLocalAssemblyClasspath: Target[Seq[PathRef]]

Upstream classfiles and resources from locally-built modules necessary to build an executable assembly, but without this module's contribution

Upstream classfiles and resources from locally-built modules necessary to build an executable assembly, but without this module's contribution

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * Optional information about the used version scheme.\n * This may enable dependency resolvers to properly resolve version ranges and version mismatches (conflicts).\n * This information will be written as `info.versionScheme` property in the `pom.xml`.\n * See [[VersionScheme]] for possible values.\n *\n * You can find more info under these links:\n * - https://docs.scala-lang.org/overviews/core/binary-compatibility-for-library-authors.html#recommended-versioning-scheme\n * - https://www.scala-lang.org/blog/2021/02/16/preventing-version-conflicts-with-versionscheme.html\n * - https://www.scala-sbt.org/1.x/docs/Publishing.html#Version+scheme\n * - https://semver.org\n *\n * @since Mill after 0.10.0-M5\n */")
def versionScheme: Target[Option[VersionScheme]]

Optional information about the used version scheme. This may enable dependency resolvers to properly resolve version ranges and version mismatches (conflicts). This information will be written as info.versionScheme property in the pom.xml. See VersionScheme for possible values.

Optional information about the used version scheme. This may enable dependency resolvers to properly resolve version ranges and version mismatches (conflicts). This information will be written as info.versionScheme property in the pom.xml. See VersionScheme for possible values.

You can find more info under these links:

Attributes

Since

Mill after 0.10.0-M5

Inherited from:
PublishModule
@Scaladoc(value = "/**\n * Files extensions that need to be managed by Zinc together with class files.\n * This means, if zinc needs to remove a class file, it will also remove files\n * which match the class file basename and a listed file extension.\n */")
def zincAuxiliaryClassFileExtensions: Target[Seq[String]]

Files extensions that need to be managed by Zinc together with class files. This means, if zinc needs to remove a class file, it will also remove files which match the class file basename and a listed file extension.

Files extensions that need to be managed by Zinc together with class files. This means, if zinc needs to remove a class file, it will also remove files which match the class file basename and a listed file extension.

Attributes

Inherited from:
JavaModule
def zincIncrementalCompilation: Target[Boolean]

Attributes

Inherited from:
JavaModule
@Scaladoc(value = "/**\n * If `true`, we always show problems (errors, warnings, infos) found in all source files, even when they have not changed since the previous incremental compilation.\n * When `false`, we report only problems for files which we re-compiled.\n */")
def zincReportCachedProblems: Target[Boolean]

If true, we always show problems (errors, warnings, infos) found in all source files, even when they have not changed since the previous incremental compilation. When false, we report only problems for files which we re-compiled.

If true, we always show problems (errors, warnings, infos) found in all source files, even when they have not changed since the previous incremental compilation. When false, we report only problems for files which we re-compiled.

Attributes

Inherited from:
JavaModule

Inherited and Abstract methods

@Scaladoc(value = "/**\n * Configuration for the `pom.xml` metadata file published with this module\n */")
def pomSettings: Target[PomSettings]

Configuration for the pom.xml metadata file published with this module

Configuration for the pom.xml metadata file published with this module

Attributes

Inherited from:
PublishModule
@Scaladoc(value = "/**\n * The artifact version that this module would be published as\n */")
def publishVersion: Target[String]

The artifact version that this module would be published as

The artifact version that this module would be published as

Attributes

Inherited from:
PublishModule

Implicits

Inherited implicits

implicit def moduleNestedCtx: Nested

Attributes

Inherited from:
Module
Generated with