Interface OrePublication

  • All Superinterfaces:
    org.gradle.api.Named
    All Known Implementing Classes:
    OrePublicationImpl

    public interface OrePublication
    extends org.gradle.api.Named
    • Nested Class Summary

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

        org.gradle.api.Named.Namer
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      org.gradle.api.provider.Property<java.lang.String> getChannel()
      Get the channel to publish a release to.
      org.gradle.api.provider.Property<java.lang.Boolean> getCreateForumPost()
      Get whether a forum post should be created for this project.
      @NotNull java.lang.String getName()  
      org.gradle.api.provider.Property<java.lang.String> getProjectId()
      The project ID to publish to.
      org.gradle.api.file.ConfigurableFileCollection getPublishArtifacts()
      Get the artifact to publish.
      org.gradle.api.provider.Property<java.lang.String> getVersionBody()
      Get contents to provide as the body/changelog for a published version.
    • Method Detail

      • getName

        @Internal
        @NotNull
        @NotNull java.lang.String getName()
        Specified by:
        getName in interface org.gradle.api.Named
      • getProjectId

        @Input
        org.gradle.api.provider.Property<java.lang.String> getProjectId()
        The project ID to publish to.
        Returns:
        the project ID property
        Since:
        2.1.0
      • getCreateForumPost

        @Input
        org.gradle.api.provider.Property<java.lang.Boolean> getCreateForumPost()
        Get whether a forum post should be created for this project.

        Default: true

        Returns:
        the property for creating a forum post
        Since:
        2.1.0
      • getVersionBody

        @Input
        org.gradle.api.provider.Property<java.lang.String> getVersionBody()
        Get contents to provide as the body/changelog for a published version.

        Default: (empty)

        Returns:
        the body property
        Since:
        2.1.0
      • getChannel

        @Input
        @Optional
        org.gradle.api.provider.Property<java.lang.String> getChannel()
        Get the channel to publish a release to.
        Returns:
        the release channel.
        Since:
        2.1.0
      • getPublishArtifacts

        @InputFiles
        @SkipWhenEmpty
        @IgnoreEmptyDirectories
        org.gradle.api.file.ConfigurableFileCollection getPublishArtifacts()
        Get the artifact to publish.

        This must evaluate to a single file.

        Default: the output of the project's jar task

        Returns:
        the artifact collection
        Since:
        2.1.0