GithubInfoExtension (gradle-github-info-plugin 1.4.0 API)

ru.vyarus.gradle.plugin.github.GithubInfoExtension

Github info extension. Repository name is set to project name by default. Required fields are: user and license.
licenseUrl will lead to LICENSE or LICENSE.txt file if it exists in project root.
Most useful licenses are recognized and licenseName and licenseUrl could be set automatically (see LicenseHelper for all supported). If license is not recognized, other license properties must be filled manually.
Other fields are generated automatically using conventions, but they still may be overridden manually.
For example, minimal configuration:
```
     github {
         user 'user'
         license 'MIT'
     }
 
```
Generated fields may be used in other configurations like pom generation. Simply reference required property github.site
Special method rawFileUrl may be used to generate direct links to files on github repository.
Authors:
Vyacheslav Rusakov
Since:
10.11.2015

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`branch` Branch name for file links (like license).
`java.lang.String`	`changelogFile`
`java.lang.String`	`issues`
`java.lang.String`	`license` License short name (e.g.
`java.lang.String`	`licenseName`
`java.lang.String`	`licenseUrl`
`java.lang.String`	`repository` Github repository name.
`java.lang.String`	`repositoryUrl`
`java.lang.String`	`scmConnection`
`java.lang.String`	`site`
`java.lang.String`	`user` Github user (or organization) name.
`java.lang.String`	`vcsUrl`

Constructor Summary

Constructors
Constructor and description
`GithubInfoExtension (org.gradle.api.Project project)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.String`	`baseUrlPart()` @return base repository url part (without protocol: 'github.com/user/repo')
	`java.lang.String`	`getChangelogFile()` Changelog file path relative to root.
	`java.lang.String`	`getIssues()` Issue tracker url.
	`java.lang.String`	`getLicenseName()` License name (e.g.
	`java.lang.String`	`getLicenseUrl()` License url.
	`java.lang.String`	`getRepositoryUrl()` Repository url (github site link).
	`java.lang.String`	`getScmConnection()` Scm connection url.
	`java.lang.String`	`getSite()` Site url.
	`java.lang.String`	`getVcsUrl()` Vcs url.
	`java.lang.String`	`rawFileUrl(java.lang.String filePath)` Shortcut for rawFileUrl(java.lang.String, java.lang.String) with default branch.
	`java.lang.String`	`rawFileUrl(java.lang.String filePath, java.lang.String branch)` @param filePath file path from project root

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - java.lang.String branch
    
    Branch name for file links (like license). Used 'HEAD' by default because github default branch was changed to 'main', but many projects continue using 'master'. HEAD would automatically redirect into correct branch.
  - java.lang.String changelogFile
  - java.lang.String issues
  - java.lang.String license
    
    License short name (e.g. MIT). Required field.
  - java.lang.String licenseName
  - java.lang.String licenseUrl
  - java.lang.String repository
    
    Github repository name. If not specified will be the same as project name.
  - java.lang.String repositoryUrl
  - java.lang.String scmConnection
  - java.lang.String site
  - java.lang.String user
    
    Github user (or organization) name. Required field.
  - java.lang.String vcsUrl
- Constructor Detail
  - GithubInfoExtension(org.gradle.api.Project project)
- Method Detail
  - java.lang.String baseUrlPart()
    
    Returns:
    base repository url part (without protocol: 'github.com/user/repo')
  - java.lang.String getChangelogFile()
    
    Changelog file path relative to root. Default to CHANGELOG.md, CHANGELOG.txt or CHANGELOG if file with this name found in project root, otherwise should be specified manually.
  - java.lang.String getIssues()
    
    Issue tracker url. By default, github issues url (https://github.com/user/repo/issues).
  - java.lang.String getLicenseName()
    
    License name (e.g. The MIT License). Required for some licenses.
  - java.lang.String getLicenseUrl()
    
    License url. If LICENSE (or LICENSE.txt) file contained in repository root, url will lead to this file, otherwise field must be filled manually for some licenses.
  - java.lang.String getRepositoryUrl()
    
    Repository url (github site link). By default, https://github.com/user/repo
  - java.lang.String getScmConnection()
    
    Scm connection url. By default, git scm url (scm:git:git://github.com/user/repo)
  - @java.lang.SuppressWarnings('UnnecessaryGetter') java.lang.String getSite()
    
    Site url. By default, repository url (https://github.com/user/repo)
  - java.lang.String getVcsUrl()
    
    Vcs url. By default, github git url (https://github.com/user/repo)
  - java.lang.String rawFileUrl(java.lang.String filePath)
    
    Shortcut for rawFileUrl(java.lang.String, java.lang.String) with default branch.
    Parameters:
    filePath - file path from project root
    Returns:
    direct link to file on github
  - java.lang.String rawFileUrl(java.lang.String filePath, java.lang.String branch)
    
    Parameters:
    filePath - file path from project root
    branch - git branch (HEAD by default to auto redirect to correct branch)
    Returns:
    direct link to file on github

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class GithubInfoExtension

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.lang.String branch

java.lang.String changelogFile

java.lang.String issues

java.lang.String license

java.lang.String licenseName

java.lang.String licenseUrl

java.lang.String repository

java.lang.String repositoryUrl

java.lang.String scmConnection

java.lang.String site

java.lang.String user

java.lang.String vcsUrl

Constructor Detail

GithubInfoExtension(org.gradle.api.Project project)

Method Detail

java.lang.String baseUrlPart()

java.lang.String getChangelogFile()

java.lang.String getIssues()

java.lang.String getLicenseName()

java.lang.String getLicenseUrl()

java.lang.String getRepositoryUrl()

java.lang.String getScmConnection()

@java.lang.SuppressWarnings('UnnecessaryGetter') java.lang.String getSite()

java.lang.String getVcsUrl()

java.lang.String rawFileUrl(java.lang.String filePath)

java.lang.String rawFileUrl(java.lang.String filePath, java.lang.String branch)