github-release-notes:write-release-notes

Full name:

com.basistech:github-release-notes-maven-plugin:0.0.1-SNAPSHOT:write-release-notes

Description:

Write release notes file to github's release/tag structure.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: verify.

Required Parameters

Name Type Since Description
releaseNotes File - Location of the file containing the release notes.
Default value is: ${basedir}/RELEASE-NOTES.md.

Optional Parameters

Name Type Since Description
host String - The Host for API calls. By default, the plugin reads this from the scm developerConnection.
Default value is: ${github.global.host}.
keystore File - If you are using this plugin with github-for-enterprise, and your server's SSL certificate is signed with a certificate that is not trusted by the JRE, you must supply a keystore file that serves as a trust store to reassure Java about the server's certificate.
oauth2Token String - The oauth2 token for authentication. You probably want to create a server in settings.xml with your token in the password element and no username element. The plugin will use that password as an oauth2 token.
Default value is: ${github.global.oauth2Token}.
password String - The password for authentication. You probably want to use a server in settings.xml.
Default value is: {github.global.password}.
serverId String - The id of the server to use to retrieve the Github credentials. This id must identify a server in your setting.xml file.
Default value is: ${github.global.server}.
User property is: server.
skip boolean - Skip execution if this is true.
tag String - SCM tag version. If this is not set, the plugin will look for an existng property named 'scm.tag'. Failing that, it will look for a file named 'release.properties', read it, and lookm for that property. Default is scm.tag property. Thus, if you run this goal after release:prepare and before release:perform, it will read the value from the file.
User property is: tag.
userName String - The user name for authentication. You probably want to use a server in settings.xml.
Default value is: ${github.global.userName}.

Parameter Details

host:

The Host for API calls. By default, the plugin reads this from the scm developerConnection.
  • Type: java.lang.String
  • Required: No
  • Default: ${github.global.host}

keystore:

If you are using this plugin with github-for-enterprise, and your server's SSL certificate is signed with a certificate that is not trusted by the JRE, you must supply a keystore file that serves as a trust store to reassure Java about the server's certificate.
  • Type: java.io.File
  • Required: No

oauth2Token:

The oauth2 token for authentication. You probably want to create a server in settings.xml with your token in the password element and no username element. The plugin will use that password as an oauth2 token.
  • Type: java.lang.String
  • Required: No
  • Default: ${github.global.oauth2Token}

password:

The password for authentication. You probably want to use a server in settings.xml.
  • Type: java.lang.String
  • Required: No
  • Default: {github.global.password}

releaseNotes:

Location of the file containing the release notes.
  • Type: java.io.File
  • Required: Yes
  • Default: ${basedir}/RELEASE-NOTES.md

serverId:

The id of the server to use to retrieve the Github credentials. This id must identify a server in your setting.xml file.
  • Type: java.lang.String
  • Required: No
  • User Property: server
  • Default: ${github.global.server}

skip:

Skip execution if this is true.
  • Type: boolean
  • Required: No

tag:

SCM tag version. If this is not set, the plugin will look for an existng property named 'scm.tag'. Failing that, it will look for a file named 'release.properties', read it, and lookm for that property. Default is scm.tag property. Thus, if you run this goal after release:prepare and before release:perform, it will read the value from the file.
  • Type: java.lang.String
  • Required: No
  • User Property: tag

userName:

The user name for authentication. You probably want to use a server in settings.xml.
  • Type: java.lang.String
  • Required: No
  • Default: ${github.global.userName}