elharo commented on code in PR #86:
URL:
https://github.com/apache/maven-changes-plugin/pull/86#discussion_r1864909698
##########
src/site/apt/examples/configuring-github-report.apt.vm:
##########
@@ -34,32 +34,31 @@ Configuring the GitHub Report
* Using GitHub Enterprise
- If you are using GitHub Enterprise you will want to make sure that the
- githubAPIScheme and githubAPIPort are correct (they default to "http" and 80
- by default). If either of these are incorrect make sure to include them in
- your configuration.
+ Additional configurations are not needed. Address of your <<GitHub>>
instance will be taken from <<<project -> issueManagement -> url>>>
+
+* Authenticating to the GitHub REST API
+
+ If you are using GitHub Enterprise or you want to authenticate to GitHub you
will want to add server configuration in your settings.xml, like:
Review Comment:
Github, configure the server in settings.xml like so:
##########
src/site/apt/examples/configuring-github-report.apt.vm:
##########
@@ -34,32 +34,31 @@ Configuring the GitHub Report
* Using GitHub Enterprise
- If you are using GitHub Enterprise you will want to make sure that the
- githubAPIScheme and githubAPIPort are correct (they default to "http" and 80
- by default). If either of these are incorrect make sure to include them in
- your configuration.
+ Additional configurations are not needed. Address of your <<GitHub>>
instance will be taken from <<<project -> issueManagement -> url>>>
+
+* Authenticating to the GitHub REST API
+
+ If you are using GitHub Enterprise or you want to authenticate to GitHub you
will want to add server configuration in your settings.xml, like:
+-----------------+
-<project>
+<settings>
...
- <reporting>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-changes-plugin</artifactId>
- <version>${project.version}</version>
- <configuration>
- <githubAPIScheme>https</githubAPIScheme>
- <githubAPIPort>443</githubAPIPort>
- </configuration>
- ...
- </plugin>
- </plugins>
- </reporting>
+ <servers>
+ <server>
+ <id>github</id>
+ <password>YOUR-TOKEN</password>
+ </server>
+ </servers>
...
-</project>
+</settings>
+-----------------+
+ Only <<<password>>> item is used as your token for <<<Authorization: Bearer
YOUR-TOKEN>>>
Review Comment:
Only the
##########
src/site/apt/examples/configuring-github-report.apt.vm:
##########
@@ -34,32 +34,31 @@ Configuring the GitHub Report
* Using GitHub Enterprise
- If you are using GitHub Enterprise you will want to make sure that the
- githubAPIScheme and githubAPIPort are correct (they default to "http" and 80
- by default). If either of these are incorrect make sure to include them in
- your configuration.
+ Additional configurations are not needed. Address of your <<GitHub>>
instance will be taken from <<<project -> issueManagement -> url>>>
+
+* Authenticating to the GitHub REST API
+
+ If you are using GitHub Enterprise or you want to authenticate to GitHub you
will want to add server configuration in your settings.xml, like:
+-----------------+
-<project>
+<settings>
...
- <reporting>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-changes-plugin</artifactId>
- <version>${project.version}</version>
- <configuration>
- <githubAPIScheme>https</githubAPIScheme>
- <githubAPIPort>443</githubAPIPort>
- </configuration>
- ...
- </plugin>
- </plugins>
- </reporting>
+ <servers>
+ <server>
+ <id>github</id>
+ <password>YOUR-TOKEN</password>
+ </server>
+ </servers>
...
-</project>
+</settings>
+-----------------+
+ Only <<<password>>> item is used as your token for <<<Authorization: Bearer
YOUR-TOKEN>>>
+
+ Default serverId is <<<github>>>, you can change it by
<<<\<githubAPIServerId\>>>> configuration parameter.
Review Comment:
The default serverId is <<<github>>>. You can change it by setting the
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscr...@maven.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
