trait PublishModule extends Module with JavaModule
Configuration necessary for publishing a Scala module to Maven Central or similar
- Self Type
- PublishModule
- Alphabetic
- By Inheritance
- PublishModule
- JavaModule
- OfflineSupportModule
- CoursierModule
- GenIdeaModule
- TaskModule
- Module
- Cacher
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- trait JavaModuleTests extends Module with TestModule
- Definition Classes
- JavaModule
- trait Tests extends Module with JavaModuleTests
- Definition Classes
- JavaModule
Abstract Value Members
- abstract def pomSettings: T[PomSettings]
- abstract def publishVersion: T[String]
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def allSourceFiles: Target[Seq[api.PathRef]]
All individual source files fed into the Java compiler
All individual source files fed into the Java compiler
- Definition Classes
- JavaModule
- def allSources: Target[Seq[eval.PathRef]]
The folders containing all source files fed into the compiler
The folders containing all source files fed into the compiler
- Definition Classes
- JavaModule
- def artifactId: T[String]
The exact id of the artifact to be published.
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
- Definition Classes
- JavaModule
- def artifactMetadata: Target[Artifact]
- def artifactName: T[String]
Override this to change the published artifact id.
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.
- Definition Classes
- JavaModule
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def assembly: Target[eval.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
- Definition Classes
- JavaModule
- def assemblyRules: Seq[Rule]
- Definition Classes
- JavaModule
- def cachedTarget[T](t: => T)(implicit c: Enclosing): T
- Attributes
- protected[this]
- Definition Classes
- Cacher
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def compile: T[CompilationResult]
Compiles the current module to generate compiled classfiles/bytecode
Compiles the current module to generate compiled classfiles/bytecode
- Definition Classes
- JavaModule
- def compileClasspath: Target[api.Loose.Agg[eval.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
- Definition Classes
- JavaModule
- def compileIvyDeps: Target[api.Loose.Agg[Dep]]
Same as
ivyDeps, but only present at compile time.Same as
ivyDeps, but only present at compile time. Useful for e.g. macro-related dependencies likescala-reflectthat doesn't need to be present at runtime- Definition Classes
- JavaModule
- def compileModuleDeps: Seq[JavaModule]
The compile-only direct dependencies of this module.
The compile-only direct dependencies of this module.
- Definition Classes
- JavaModule
- def defaultCommandName(): String
- Definition Classes
- JavaModule → TaskModule
- def docJar: Target[eval.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
- Definition Classes
- JavaModule
- def docSources: Sources
Extra directories to be processed by the API documentation tool.
Extra directories to be processed by the API documentation tool.
Typically includes static files such as html and markdown, but depends on the doc tool that is actually used.
- Definition Classes
- JavaModule
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def extraPublish: Target[Seq[PublishInfo]]
Extra artifacts to publish.
- def finalMainClass: T[String]
- Definition Classes
- JavaModule
- def finalMainClassOpt: T[Either[String, String]]
- Definition Classes
- JavaModule
- def forkArgs: Target[Seq[String]]
Any command-line parameters you want to pass to the forked JVM under
run,testorreplAny command-line parameters you want to pass to the forked JVM under
run,testorrepl- Definition Classes
- JavaModule
- def forkEnv: Target[Map[String, String]]
Any environment variables you want to pass to the forked JVM under
run,testorreplAny environment variables you want to pass to the forked JVM under
run,testorrepl- Definition Classes
- JavaModule
- def forkWorkingDir: Target[Path]
- Definition Classes
- JavaModule
- def generatedSources: Target[Seq[eval.PathRef]]
Folders containing source files that are generated rather than hand-written; 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 hand-written; these files can be generated in this target itself, or can refer to files generated from other targets
- Definition Classes
- JavaModule
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def ideaCompileOutput: T[PathRef]
- Definition Classes
- GenIdeaModule
- def ideaConfigFiles(ideaConfigVersion: Int): Command[Seq[IdeaConfigFile]]
Contribute components to idea config files.
Contribute components to idea config files.
- Definition Classes
- GenIdeaModule
- def ideaJavaModuleFacets(ideaConfigVersion: Int): Command[Seq[JavaFacet]]
Contribute facets to the Java module configuration.
Contribute facets to the Java module configuration.
- ideaConfigVersion
The IDEA configuration version in use. Probably
4.
- Definition Classes
- GenIdeaModule
- def intellijModulePath: Path
- Definition Classes
- GenIdeaModule
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def ivy: Target[api.PathRef]
- def ivyDeps: Target[api.Loose.Agg[Dep]]
Any ivy dependencies you want to add to this Module, in the format ivy"org::name:version" for Scala dependencies or ivy"org:name:version" for Java dependencies
Any ivy dependencies you want to add to this Module, in the format ivy"org::name:version" for Scala dependencies or ivy"org:name:version" for Java dependencies
- Definition Classes
- JavaModule
- def ivyDepsTree(inverse: Boolean = false, withCompile: Boolean = false, withRuntime: Boolean = false): Command[Unit]
Command to print the transitive dependency tree to STDOUT.
Command to print the transitive dependency tree to STDOUT.
- inverse
Invert the tree representation, so that the root is on the bottom.
- withCompile
Include the compile-time only dependencies (
compileIvyDeps, provided scope) into the tree.- withRuntime
Include the runtime dependencies (
runIvyDeps, runtime scope) into the tree.
- Definition Classes
- JavaModule
- def jar: Target[eval.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
- Definition Classes
- JavaModule
- def javacOptions: Target[Seq[String]]
Options to pass to the java compiler
Options to pass to the java compiler
- Definition Classes
- JavaModule
- def javadocOptions: T[Seq[String]]
Additional options to be used by the javadoc tool.
Additional options to be used by the javadoc tool. You should not set the
-dsetting for specifying the target directory, as that is done in the docJar target.- Definition Classes
- JavaModule
- def launcher: Target[api.PathRef]
Builds a command-line "launcher" file that can be used to run this module's code, without the Mill process.
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
- Definition Classes
- JavaModule
- def localClasspath: Target[Seq[eval.PathRef]]
The output classfiles/resources from this module, excluding upstream modules and third-party dependencies
The output classfiles/resources from this module, excluding upstream modules and third-party dependencies
- Definition Classes
- JavaModule
- def mainClass: T[Option[String]]
Allows you to specify an explicit main class to use for the
runcommand.Allows you to specify an explicit main class to use for the
runcommand. If none is specified, the classpath is searched for an appropriate main class to use if one exists- Definition Classes
- JavaModule
- def manifest: T[JarManifest]
Creates a manifest representation which can be modifed or replaced The default implementation just adds the
Manifest-Version,Main-ClassandCreated-ByattributesCreates a manifest representation which can be modifed or replaced The default implementation just adds the
Manifest-Version,Main-ClassandCreated-Byattributes- Definition Classes
- JavaModule
- def mapDependencies: Task[(Dependency) => Dependency]
Map dependencies before resolving them.
Map dependencies before resolving them. Override this to customize the set of dependencies.
- Definition Classes
- CoursierModule
- implicit def millModuleBasePath: BasePath
- Definition Classes
- Module
- lazy val millModuleDirectChildren: Seq[define.Module]
- Definition Classes
- Module
- implicit def millModuleExternal: External
- Definition Classes
- Module
- implicit def millModuleSegments: Segments
- Definition Classes
- Module
- implicit def millModuleShared: Foreign
- Definition Classes
- Module
- def millOuterCtx: Ctx
- Definition Classes
- Module
- def millSourcePath: Path
- Definition Classes
- Module
- def moduleDeps: Seq[PublishModule]
The direct dependencies of this module
The direct dependencies of this module
- Definition Classes
- PublishModule → JavaModule
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def platformSuffix: T[String]
What platform suffix to use for publishing, e.g.
What platform suffix to use for publishing, e.g.
_sjsfor Scala.js projects- Definition Classes
- JavaModule
- def pom: Target[api.PathRef]
- def prepareOffline(): Command[Unit]
Prepare the module for working offline.
Prepare the module for working offline. This should typically fetch (missing) resources like ivy dependencies.
- Definition Classes
- JavaModule → OfflineSupportModule
- def prependShellScript: T[String]
What shell script to use to launch the executable generated by
assembly.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- Definition Classes
- JavaModule
- def printDepsTree(inverse: Boolean, additionalDeps: Task[api.Loose.Agg[Dep]]): Task[Unit]
Task that print the transitive dependency tree to STDOUT.
Task that print the transitive dependency tree to STDOUT.
- inverse
Invert the tree representation, so that the root is on the bottom.
- additionalDeps
Additional dependency to be included into the tree.
- Attributes
- protected
- Definition Classes
- JavaModule
- def publish(sonatypeCreds: String, signed: Boolean = true, gpgArgs: Seq[String] = PublishModule.defaultGpgArgs, release: Boolean = false, readTimeout: Int = 60000, connectTimeout: Int = 5000, awaitTimeout: Int = 120 * 1000, stagingRelease: Boolean = true): Command[Unit]
Publish all given artifacts to Sonatype.
Publish all given artifacts to Sonatype.
- 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.
- def publishArtifacts: Target[PublishData]
- def publishLocal(localIvyRepo: String = null): Command[Unit]
Publish artifacts to a local ivy repository.
Publish artifacts to a local ivy repository.
- localIvyRepo
The local ivy repository. If not defined, defaults to
$HOME/.ivy2/local
- def publishM2Local(m2RepoPath: String = os.home / ".m2" / "repository").toString()): Command[Seq[api.PathRef]]
Publish artifacts to a local Maven repository.
Publish artifacts to a local Maven repository.
- m2RepoPath
The path to the local repository as string (default:
$HOME/.m2repository).- returns
PathRefs to published files.
- def publishSelfDependency: Target[Artifact]
- def publishXmlDeps: Task[Agg[Dependency]]
- def recursiveModuleDeps: Seq[JavaModule]
The direct and indirect dependencies of this module
The direct and indirect dependencies of this module
- Definition Classes
- JavaModule
- def repositoriesTask: Task[Seq[Repository]]
The repositories used to resolved dependencies with resolveDeps().
The repositories used to resolved dependencies with resolveDeps().
- Definition Classes
- CoursierModule
- def resolveCoursierDependency: Task[(Dep) => Dependency]
- Definition Classes
- CoursierModule
- def resolveDeps(deps: Task[Agg[Dep]], sources: Boolean = false): Task[Agg[eval.PathRef]]
Task that resolves the given dependencies using the repositories defined with repositories.
Task that resolves the given dependencies using the repositories defined with repositories.
- deps
The dependencies to resolve.
- sources
If
true, resolve source dependencies instead of binary dependencies (JARs).- returns
The PathRefs to the resolved files.
- Definition Classes
- CoursierModule
- def resolvePublishDependency: Task[(Dep) => Dependency]
- Definition Classes
- JavaModule
- def resolvedIvyDeps: T[api.Loose.Agg[eval.PathRef]]
- Definition Classes
- JavaModule
- def resolvedRunIvyDeps: T[api.Loose.Agg[eval.PathRef]]
- Definition Classes
- JavaModule
- def resources: Sources
The folders where the resource files for this module live
The folders where the resource files for this module live
- Definition Classes
- JavaModule
- def run(args: String*): 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
- Definition Classes
- JavaModule
- def runBackground(args: String*): Command[Unit]
Runs this module's code in a background process, until it dies or
runBackgroundis used again.Runs this module's code in a background process, until it dies or
runBackgroundis 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.runBackgroundto 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- Definition Classes
- JavaModule
- def runClasspath: Target[Seq[eval.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
- Definition Classes
- JavaModule
- def runIvyDeps: Target[api.Loose.Agg[Dep]]
Same as
ivyDeps, but only present at runtime.Same as
ivyDeps, but 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- Definition Classes
- JavaModule
- def runLocal(args: String*): Command[Unit]
Runs this module's code in-process within an isolated classloader.
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.- Definition Classes
- JavaModule
- def runMain(mainClass: String, args: String*): Command[Unit]
Same as
run, but lets you specify a main class to runSame as
run, but lets you specify a main class to run- Definition Classes
- JavaModule
- def runMainBackground(mainClass: String, args: String*): Command[Unit]
Same as
runBackground, but lets you specify a main class to runSame as
runBackground, but lets you specify a main class to run- Definition Classes
- JavaModule
- def runMainLocal(mainClass: String, args: String*): Command[Unit]
Same as
runLocal, but lets you specify a main class to runSame as
runLocal, but lets you specify a main class to run- Definition Classes
- JavaModule
- def showModuleDeps(recursive: Boolean = false): Command[Unit]
Show the module dependencies.
Show the module dependencies.
- recursive
If
trueinclude all recursive module dependencies, else only show direct dependencies.
- Definition Classes
- JavaModule
- def skipIdea: Boolean
Skip Idea project file generation.
Skip Idea project file generation.
- Definition Classes
- GenIdeaModule
- def sonatypeSnapshotUri: String
- def sonatypeUri: String
- def sourceJar: Target[eval.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
- Definition Classes
- JavaModule
- def sources: Sources
The folders where the source files for this module live
The folders where the source files for this module live
- Definition Classes
- JavaModule
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- Module → AnyRef → Any
- def transitiveCompileIvyDeps: T[api.Loose.Agg[Dep]]
The compile-only transitive ivy dependencies of this module and all it's upstream compile-only modules.
The compile-only transitive ivy dependencies of this module and all it's upstream compile-only modules.
- Definition Classes
- JavaModule
- def transitiveIvyDeps: T[api.Loose.Agg[Dep]]
The transitive ivy dependencies of this module and all it's upstream modules
The transitive ivy dependencies of this module and all it's upstream modules
- Definition Classes
- JavaModule
- def transitiveLocalClasspath: T[api.Loose.Agg[eval.PathRef]]
The transitive version of
localClasspathThe transitive version of
localClasspath- Definition Classes
- JavaModule
- def transitiveModuleDeps: Seq[JavaModule]
Like
recursiveModuleDepsbut also include the module itselfLike
recursiveModuleDepsbut also include the module itself- Definition Classes
- JavaModule
- def unmanagedClasspath: Target[api.Loose.Agg[eval.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
- Definition Classes
- JavaModule
- def upstreamAssembly: Target[eval.PathRef]
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
- Definition Classes
- JavaModule
- def upstreamAssemblyClasspath: Target[api.Loose.Agg[eval.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
- Definition Classes
- JavaModule
- 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
- Definition Classes
- JavaModule
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def zincWorker: ZincWorkerModule
- Definition Classes
- JavaModule
- object millInternal extends Internal
- Definition Classes
- Module
- Annotations
- @Scaladoc()
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
- def repositories: Seq[Repository]
The repositories used to resolved dependencies with resolveDeps().
The repositories used to resolved dependencies with resolveDeps().
- Definition Classes
- CoursierModule
- Annotations
- @deprecated
- Deprecated
(Since version after mill 0.8.0) Use repositoriesTask instead