Package org.apache.maven.plugins.changes.github

Class GitHubChangesReport

java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.apache.maven.plugins.changes.AbstractChangesReport
org.apache.maven.plugins.changes.github.GitHubChangesReport
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenMultiPageReport, org.apache.maven.reporting.MavenReport
Direct Known Subclasses:
GitHubDeprecatedReport
@Mojo(name="github-changes", threadSafe=true) public class GitHubChangesReport extends AbstractChangesReport
Goal which downloads issues from GitHub and generates a report.
Since:
2.8
Author:
Bryan Baugher

  • Field Summary

    Fields inherited from class org.apache.maven.plugins.changes.AbstractChangesReport

    basedir, mavenSession, runOnlyAtExecutionRoot

    Fields inherited from class org.apache.maven.reporting.AbstractMavenReport

    locale, mojoExecution, outputDirectory, outputFormat, outputTimestamp, project, reactorProjects, remoteProjectRepositories, repoSession, siteDirectory, siteRenderer, siteTool

    Fields inherited from interface org.apache.maven.reporting.MavenReport

    CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

    Fields inherited from interface org.apache.maven.plugin.Mojo

    ROLE

  • Constructor Summary

    Constructors
    Constructor
    Description
    GitHubChangesReport(org.apache.maven.settings.crypto.SettingsDecrypter settingsDecrypter)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canGenerateReport()
     
    protected void
    executeReport(Locale locale)
     
    String
    getDescription(Locale locale)
     
    String
    getName(Locale locale)
     
    String
    getOutputName()
    Deprecated.

    Methods inherited from class org.apache.maven.plugins.changes.AbstractChangesReport

    isThisTheExecutionRoot

    Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

    closeReport, constructXrefLocation, execute, generate, generate, getCategoryName, getInputEncoding, getLocale, getOutputDirectory, getOutputEncoding, getProject, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, getXrefLocation, isExternalReport, setReportOutputDirectory

    Methods inherited from class org.apache.maven.plugin.AbstractMojo

    getLog, getPluginContext, setLog, setPluginContext

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.apache.maven.reporting.MavenReport

    getOutputPath

  • Constructor Details

    • GitHubChangesReport

      @Inject public GitHubChangesReport(org.apache.maven.settings.crypto.SettingsDecrypter settingsDecrypter)

  • Method Details

    • getOutputName

      @Deprecated public String getOutputName()
      Deprecated.

    • getName

      public String getName(Locale locale)

    • getDescription

      public String getDescription(Locale locale)

    • canGenerateReport

      public boolean canGenerateReport()
      Specified by:
      canGenerateReport in interface org.apache.maven.reporting.MavenReport
      Overrides:
      canGenerateReport in class org.apache.maven.reporting.AbstractMavenReport
      See Also:
      • AbstractMavenReport.canGenerateReport()

    • executeReport

      protected void executeReport(Locale locale) throws org.apache.maven.reporting.MavenReportException
      Specified by:
      executeReport in class org.apache.maven.reporting.AbstractMavenReport
      Throws:
      org.apache.maven.reporting.MavenReportException