GitHub Releases Platform

Class: UpdateChecker

Required options

• owner
  GitHub repository owner or organization name.
• repo
  GitHub repository name.
• currentVersion
  Current plugin version to compare against latest release tag.

Optional options

• githubToken(String githubToken)
  Optional token for private repositories and higher rate limits.
• timeout(Duration timeout)
  HTTP request timeout. Default: 8s.
• userAgent(String userAgent)
  Custom user agent header. Default: ezplugins-github-update-checker.
• apiBaseUrl(String apiBaseUrl)
  Override API base URL. Default: https://api.github.com.

Example

UpdateChecker checker = UpdateChecker.builder("PVP-Index", "pvpindex-factions", "1.2.3")
        .githubToken(System.getenv("GITHUB_TOKEN"))
        .timeout(java.time.Duration.ofSeconds(5))
        .build();