配置 GitHub 报告

注意：有关在哪个版本中添加了哪个功能的详细信息，请参阅目标文档。

使用 GitHub Enterprise

如果您使用的是 GitHub Enterprise，您需要确保 githubAPIScheme 和 githubAPIPort 正确（它们默认为“http”，默认为 80）。如果其中任何一个不正确，请确保将它们包含在您的配置中。

<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-changes-plugin</artifactId>
        <version>2.12.1</version>
        <configuration>
          <githubAPIScheme>https</githubAPIScheme>
          <githubAPIPort>443</githubAPIPort>
        </configuration>
        ...
      </plugin>
    </plugins>
  </reporting>
  ...
</project>

过滤问题

我们将从为您的项目的一个或多个版本创建 GitHub 报告开始。有两种方法可以做到这一点。

仅包括已关闭的问题

如果您只想在报告中包含已关闭的问题，请确保在您的配置中将 includeOpenIssues 配置为 false，默认情况下为 true。

<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-changes-plugin</artifactId>
        <version>2.12.1</version>
        <configuration>
          <includeOpenIssues>false</includeOpenIssues>
        </configuration>
        ...
      </plugin>
    </plugins>
  </reporting>
  ...
</project>

包括没有里程碑的问题

如果您只想在报告中包含没有附加里程碑的问题，请确保在您的配置中将 onlyMilestoneIssues 配置为 false，默认情况下为 true。

<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-changes-plugin</artifactId>
        <version>2.12.1</version>
        <configuration>
          <onlyMilestoneIssues>false</onlyMilestoneIssues>
        </configuration>
        ...
      </plugin>
    </plugins>
  </reporting>
  ...
</project>

使用当前版本

如果你很懒，只想在你的 GitHub 报告中找到最新版本，你可以使用<onlyCurrentVersion>配置参数。它将从项目的 POM 中获取版本，并尝试将其与 GitHub 问题的里程碑标题进行匹配。

一旦你配置了它，你就可以忘记它，因为当你更改 POM 中的版本号时它会自行更新。

注意：您在 GitHub 中的里程碑名称必须与您在 POM 中使用的名称相匹配。POM 中版本的-SNAPSHOT部分由插件自动处理，因此您无需在 GitHub 中的里程碑名称中包含-SNAPSHOT。

<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-changes-plugin</artifactId>
        <version>2.12.1</version>
        <configuration>
          <onlyCurrentVersion>true</onlyCurrentVersion>
        </configuration>
        ...
      </plugin>
    </plugins>
  </reporting>
  ...
</project>

选择列

您可以选择要包含在报告中的列。

<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-changes-plugin</artifactId>
        <version>2.12.1</version>
        <configuration>
          <columnNames>Type,Key,Summary,Assignee,Status,Fix Version</columnNames>
        </configuration>
        ...
      </plugin>
    </plugins>
  </reporting>
  ...
</project>