https://github.com/jenkinsci/github-api-plugin

This plugin packages stock github-api library
https://github.com/jenkinsci/github-api-plugin

api-wrapper github github-api jenkins jenkins-api-plugin jenkins-plugin

Last synced: about 1 month ago
JSON representation

This plugin packages stock github-api library

• Host: GitHub
• URL: https://github.com/jenkinsci/github-api-plugin
• Owner: jenkinsci
• Created: 2012-01-04T18:05:22.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2024-08-06T18:00:16.000Z (about 1 month ago)
• Last Synced: 2024-08-06T21:32:11.485Z (about 1 month ago)
• Topics: api-wrapper, github, github-api, jenkins, jenkins-api-plugin, jenkins-plugin
• Language: Java
• Homepage: https://plugins.jenkins.io/github-api/
• Size: 270 KB
• Stars: 25
• Watchers: 106
• Forks: 58
• Open Issues: 3
• Metadata Files:
  • Readme: README.adoc
  • Changelog: CHANGELOG.adoc
  • Contributing: CONTRIBUTING.adoc
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# GitHub API Plugin for Jenkins

image:https://img.shields.io/jenkins/plugin/v/github-api.svg[link="https://plugins.jenkins.io/github-api"]

image:https://img.shields.io/github/release/jenkinsci/github-api-plugin.svg?label=changelog[link="https://github.com/jenkinsci/github-api-plugin/releases/latest"]

image:https://img.shields.io/jenkins/plugin/i/github-api.svg?color=blue[link="https://plugins.jenkins.io/github-api"]

This jenkins plugin packages the stock https://github.com/kohsuke/github-api[github-api] library.

Normally library should be backward-compatible. 

== Usage

This plugin is a library plugin used by other GitHub related plugins to share the same libraries.

This plugin does not have any user visible feature by itself.

There's no need to install this plugin manually, although you want to keep it up to date.

== Note to plugin developers

If you are developing a plugin that depends on http://kohsuke.org/github-api[github-api],

it's is highly recommended that you depend on this plugin as opposed to bundle the jar locally.

Doing so (as opposed to depending on `+org.kohsuke:github-api+` as a jar),

we can eliminate the classloader problems caused by having multiple copies of github-api loaded.

Specifically, if plugin A and B both locally includes its own copy of the `+github-api.jar+` and another plugin C depends on A and B, it'll break.

== Changelog

* See link:https://github.com/jenkinsci/github-api-plugin/releases[GitHub Releases] for recent plugin versions

* For versions 1.95 and older, see the link:./CHANGELOG.adoc[Changelog]

NOTE: The version number of this plugin tracks the version number of `+github-api.jar+`.

== Reporting issues

If you have any issues related to library please fill in https://github.com/kohsuke/github-api/issues[GH Issues].