Interface PromotePublication

All Superinterfaces:
Comparable<org.gradle.api.Task>, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Named, org.gradle.api.Task
@Internal public sealed interface PromotePublication extends org.gradle.api.Task
This task promotes a publication to the Forge Files Site.
API Note:
This task is internal as it is meant for use in Forge projects only.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.gradle.api.Named

    org.gradle.api.Named.Namer

  • Field Summary

    Fields inherited from interface org.gradle.api.Task

    TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

  • Method Summary

    Modifier and Type
    Method
    Description
    org.gradle.api.provider.Property<String>
    getArtifactGroup()
    The publication group to promote.
    org.gradle.api.provider.Property<String>
    getArtifactName()
    The publication name to promote.
    org.gradle.api.provider.Property<String>
    getArtifactVersion()
    The publication version to promote.
    org.gradle.api.provider.Property<String>
    getPassword()
    The password to use.
    org.gradle.api.provider.Property<String>
    getPromotionType()
    The promotion type to use.
    org.gradle.api.provider.Property<String>
    getUsername()
    The username to use.
    org.gradle.api.provider.Property<String>
    getWebhookURL()
    The webhook URL to use.

    Methods inherited from interface java.lang.Comparable

    compareTo

    Methods inherited from interface org.gradle.api.plugins.ExtensionAware

    getExtensions

    Methods inherited from interface org.gradle.api.Task

    configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, doNotTrackState, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, notCompatibleWithConfigurationCache, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

  • Method Details

    • getArtifactGroup

      @Input org.gradle.api.provider.Property<String> getArtifactGroup()

      The publication group to promote.

      By convention, this is Project.getGroup(), but the set value is MavenPublication.getGroupId().

      Returns:
      The property for the artifact group

    • getArtifactName

      @Input org.gradle.api.provider.Property<String> getArtifactName()

      The publication name to promote.

      By convention, this is BasePluginExtension.getArchivesName(), but the set value is MavenPublication.getArtifactId().

      Returns:
      The property for the artifact name

    • getArtifactVersion

      @Input org.gradle.api.provider.Property<String> getArtifactVersion()

      The publication version to promote.

      By convention, this is Project.getVersion(), but the set value is MavenPublication.getVersion().

      Returns:
      The property for the artifact version

    • getPromotionType

      @Input org.gradle.api.provider.Property<String> getPromotionType()

      The promotion type to use.

      By default, this is latest.

      Returns:
      The property for the promotion type

    • getWebhookURL

      @Input org.gradle.api.provider.Property<String> getWebhookURL()

      The webhook URL to use. If this is not set, this task will not run.

      This is set by the PROMOTE_ARTIFACT_WEBHOOK environment variable using ProviderFactory.environmentVariable(String).

      Returns:
      The property for the webhook URL.

    • getUsername

      @Input org.gradle.api.provider.Property<String> getUsername()

      The username to use. If this is not set, this task will not run.

      This is set by the PROMOTE_ARTIFACT_USERNAME environment variable using ProviderFactory.environmentVariable(String).

      Returns:
      The property for the username.

    • getPassword

      @Input org.gradle.api.provider.Property<String> getPassword()

      The password to use. If this is not set, this task will not run.

      This is set by the PROMOTE_ARTIFACT_PASSWORD environment variable using ProviderFactory.environmentVariable(String).

      Returns:
      The property for the password URL.