Mill
API
Generated with
Mill/mill/mill.scalalib/PublishModule

PublishModule

mill.scalalib.PublishModule
See thePublishModule companion trait
object PublishModule extends ExternalModule, TaskModule

Attributes

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

Members list

Type members

Classlikes

case class PublishData(meta: Artifact, payload: Seq[(PathRef, String)])

Attributes

Companion
object
Source
PublishModule.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object PublishData

Attributes

Companion
class
Source
PublishModule.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Inherited classlikes

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

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

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

Attributes

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

Value members

Concrete methods

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

Source
PublishModule.scala
def defaultGpgArgsForPassphrase(passphrase: Option[String]): Seq[String]

Attributes

Source
PublishModule.scala
def pgpImportSecretIfProvided(env: Map[String, String]): Unit

Attributes

Source
PublishModule.scala
@Scaladoc(value = "/**\n * Publish all given artifacts to Sonatype.\n * Uses environment variables SONATYPE_USERNAME and SONATYPE_PASSWORD as\n * credentials.\n *\n * @param publishArtifacts what artifacts you want to publish. Defaults to `__.publishArtifacts`\n * which selects all `PublishModule`s in your build\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 signed\n * @param gpgArgs GPG arguments. Defaults to `--passphrase=$MILL_PGP_PASSPHRASE,--no-tty,--pienty-mode,loopback,--batch,--yes,-a,-b`.\n * Specifying this will override/remove the defaults.\n * Add the default args to your args to keep them.\n * @param release Whether to release the artifacts after staging them\n * @param sonatypeUri Sonatype URI to use. Defaults to `oss.sonatype.org`, newer projects\n * may need to set it to https://s01.oss.sonatype.org/service/local\n * @param sonatypeSnapshotUri Sonatype snapshot URI to use. Defaults to `oss.sonatype.org`, newer projects\n * may need to set it to https://s01.oss.sonatype.org/content/repositories/snapshots\n * @param readTimeout How long to wait before timing out network reads\n * @param connectTimeout How long to wait before timing out network connections\n * @param awaitTimeout How long to wait before timing out on failed uploads\n * @param stagingRelease\n * @return\n */")
def publishAll(publishArtifacts: Tasks[PublishData], sonatypeCreds: String, signed: Boolean, gpgArgs: String, release: Boolean, sonatypeUri: String, sonatypeSnapshotUri: String, readTimeout: Int, connectTimeout: Int, awaitTimeout: Int, stagingRelease: Boolean): Command[Unit]

Publish all given artifacts to Sonatype. Uses environment variables SONATYPE_USERNAME and SONATYPE_PASSWORD as credentials.

Publish all given artifacts to Sonatype. Uses environment variables SONATYPE_USERNAME and SONATYPE_PASSWORD as credentials.

Value parameters

awaitTimeout

How long to wait before timing out on failed uploads

connectTimeout

How long to wait before timing out network connections

gpgArgs

GPG arguments. Defaults to --passphrase=$MILL_PGP_PASSPHRASE,--no-tty,--pienty-mode,loopback,--batch,--yes,-a,-b. Specifying this will override/remove the defaults. Add the default args to your args to keep them.

publishArtifacts

what artifacts you want to publish. Defaults to __.publishArtifacts which selects all PublishModules in your build

readTimeout

How long to wait before timing out network reads

release

Whether to release the artifacts after staging 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.

sonatypeSnapshotUri

Sonatype snapshot URI to use. Defaults to oss.sonatype.org, newer projects may need to set it to https://s01.oss.sonatype.org/content/repositories/snapshots

sonatypeUri

Sonatype URI to use. Defaults to oss.sonatype.org, newer projects may need to set it to https://s01.oss.sonatype.org/service/local

Attributes

Source
PublishModule.scala

Inherited methods

def moduleCtx: Ctx

Attributes

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

Attributes

Inherited from:
Module
Source
Module.scala
def moduleDirectChildren: Seq[Module]

Attributes

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

Attributes

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

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

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

Concrete fields

val defaultGpgArgs: Seq[String]

Attributes

Source
PublishModule.scala
lazy val millDiscover: Discover

Attributes

Source
PublishModule.scala

Implicits

Inherited implicits

implicit def moduleNestedCtx: Nested

Attributes

Inherited from:
Module
Source
Module.scala
Generated with