Package de.carne.gradle.plugin.java.ext

Class GitHubRelease

  • public class GitHubRelease
extends java.lang.Object
    Configuration object for DraftGitHubReleaseTask.

    build.gradle: 

     javatools {
  githubRelease {
   ...
  }
 }

    • Constructor Summary

      Constructors 
      Constructor Description
      GitHubRelease​(org.gradle.api.Project project)
      Constructs a new GitHubRelease instance.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getGithubToken()
      Gets the GitHub access token.
      org.gradle.api.file.ConfigurableFileTree getReleaseAssets()
      Gets the release assets to upload.
      java.lang.String getReleaseName()
      Gets the GitHub release name.
      java.io.File getReleaseNotes()
      Gets the release notes file.
      boolean isEnabled()
      Checks whether the GitHub release tasks are enabled.
      boolean isIgnoreDirty()
      Checks whether a dirty state of the local repository is ignored.
      boolean isOverwrite()
      Checks whether release overwriting is enabled.
      void setEnabled​(boolean enabled)
      Enables/disables the GitHub release tasks.
      void setGithubToken​(java.lang.String githubToken)
      Sets the GitHub access token.
      void setIgnoreDirty​(boolean ignoreDirty)
      Enables/disables ignoring of the dirty state of the local repository.
      void setOverwrite​(boolean overwrite)
      Enables/disables release overwriting.
      void setReleaseAssets​(org.gradle.api.file.ConfigurableFileTree releaseAssets)
      Sets the release assets to upload.
      void setReleaseName​(java.lang.String releaseName)
      Sets the GitHub release name.
      void setReleaseNotes​(java.io.File releaseNotes)
      Sets the release notes file.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • GitHubRelease

        public GitHubRelease​(org.gradle.api.Project project)
        Constructs a new GitHubRelease instance.
        Parameters:
        project - the owning Project.

    • Method Detail

      • isEnabled

        public boolean isEnabled()
        Checks whether the GitHub release tasks are enabled.

        build.gradle: 

         githubRelease {
  enabled = true|false // default: false
 }
        Returns:
        true if the GitHub release tasks are enabled.

      • setEnabled

        public void setEnabled​(boolean enabled)
        Enables/disables the GitHub release tasks.

        build.gradle: 

         githubRelease {
  enabled = true|false // default: false
 }
        Parameters:
        enabled - whether to enable or disable the GitHub release tasks.

      • getReleaseName

        public java.lang.String getReleaseName()
        Gets the GitHub release name.

        build.gradle: 

         githubRelease {
  releaseName = "..." // default: "v${project.version}"
 }
        Returns:
        the GitHub release name.

      • setReleaseName

        public void setReleaseName​(java.lang.String releaseName)
        Sets the GitHub release name.

        build.gradle: 

         githubRelease {
  releaseName = "..." // default: "v${project.version}"
 }
        Parameters:
        releaseName - the release name to set.

      • getReleaseNotes

        public java.io.File getReleaseNotes()
        Gets the release notes file.

        build.gradle: 

         githubRelease {
  releaseNotes = file(...) // default: file("RELEASE-v${project.version}.md");
 }
        Returns:
        the release notes file.

      • setReleaseNotes

        public void setReleaseNotes​(java.io.File releaseNotes)
        Sets the release notes file.

        build.gradle: 

         githubRelease {
  releaseNotes = file(...) // default: file("RELEASE-v${project.version}.md");
 }
        Parameters:
        releaseNotes - the release notes file to set.

      • getReleaseAssets

        public org.gradle.api.file.ConfigurableFileTree getReleaseAssets()
        Gets the release assets to upload.

        build.gradle: 

         githubRelease {
  releaseAssets = fileTree(...) // default: <undefined>
 }
        Returns:
        the release assets to upload.

      • setReleaseAssets

        public void setReleaseAssets​(org.gradle.api.file.ConfigurableFileTree releaseAssets)
        Sets the release assets to upload.

        build.gradle: 

         githubRelease {
  releaseAssets = fileTree(...) // default: <undefined>
 }
        Parameters:
        releaseAssets - the release assets to set.

      • isOverwrite

        public boolean isOverwrite()
        Checks whether release overwriting is enabled.

        build.gradle: 

         githubRelease {
  overwrite = true|false // default: false
 }
        Returns:
        true if release overwriting is enabled.

      • setOverwrite

        public void setOverwrite​(boolean overwrite)
        Enables/disables release overwriting.

        build.gradle: 

         githubRelease {
  overwrite = true|false // default: false
 }
        Parameters:
        overwrite - whether to overwrite an already existing release.

      • getGithubToken

        public java.lang.String getGithubToken()
        Gets the GitHub access token.

        build.gradle: 

         githubRelease {
  githubToken = "..." // default: <undefined>
 }
        Returns:
        the GitHub access token.

      • setGithubToken

        public void setGithubToken​(java.lang.String githubToken)
        Sets the GitHub access token.

        build.gradle: 

         githubRelease {
  githubToken = "..." // default: <undefined>
 }
        Parameters:
        githubToken - the GitHub access token to use.

      • isIgnoreDirty

        public boolean isIgnoreDirty()
        Checks whether a dirty state of the local repository is ignored.

        build.gradle: 

         githubRelease {
  ignoreDirty = true|false // default: false
 }
        Returns:
        true if a dirty state of the local repository is ignored.

      • setIgnoreDirty

        public void setIgnoreDirty​(boolean ignoreDirty)
        Enables/disables ignoring of the dirty state of the local repository.

        build.gradle: 

         githubRelease {
  overwrite = true|false // default: false
 }
        Parameters:
        ignoreDirty - whether to ignore a dirty state of the local repository.