Github-integration-plugin

1. GitHub Integration Plugin
Kanstantsin Shautsou

2. Summary
●
Triggering via git-plugin
●
Triggering via github-plugin
●
GitHub PullRequest plugin
●
GitHub Integration plugin

3. GitHub, git, jenkins and user

4. git triggering
●
What do we usually want?
– Build per commit
– Build per commit in branch. What branch?
●
How to get this info?

5. git triggering
●
How to get this info?
– `git ls-remote`
$ git ls-remote
From git@github.com:KostyaSha/yet-another-docker-plugin.git
a346efebf0149f14d3a96a2ee90a617e540298ea HEAD
997dbddbff71979a282e73a871413c6f2498c448 refs/heads/dockerShell
a346efebf0149f14d3a96a2ee90a617e540298ea refs/heads/master
ff2b5c8dc5451247d7eddfe6e20c1e7926300a80 refs/pull/100/head
cc60bb5e4b0313d7313b720c5c926bdc3de5b132 refs/pull/157/head
1881e514ee7a49c80c3f18ae49b6c199b82d9a6c refs/pull/157/merge
2f42efb8d0d91fff9b5e343dd2369ab263286f98 refs/tags/0.1.0-rc13
04f98f29534854abf1e47789ebfbc853093f1d1f refs/tags/0.1.0-rc13^{}

6. Generic SCM API

7. Git polling
(1) push
(2) poll
(4) notification
(3) build

8. Git polling
pollpoll
pollpoll
pollpoll
pollpoll
pollpoll
pollpoll
pollpoll

9. How to fix?
●
Enlarge polling intervals!

10. Git polling must die
pollpoll
pollpoll
pollpoll
pollpoll
pollpoll
pollpoll
pollpoll

11. Git/GitHub hooks
(1) push
(2) hook
(4) notification(3) build
(0) configure git/github hook
/git/notifyCommit?url=X&branches=

12. What do we want later
– Exclude some users?
– Exclude commits with some messages?
– Changelog between previous build?

13. GitSCM Additional Behaviours

14. Git/GitHub hooks
(2) hook
fetch
Require
Workspace

15. Issues
●
Cloud OneShot Slaves
●
Workspace files
●
Unexpected builds to get workspace!
●
[Bonus] Polling logic != git scm checkout logic
GitSCM.poll()→
Queue.scheduleBuild()→
Run/Build →
GITScm choose other

16. Branch vs PullRequest?
$ git ls-remote
From git@github.com:KostyaSha/yet-another-docker-plugin.git
a346efebf0149f14d3a96a2ee90a617e540298ea HEAD
997dbddbff71979a282e73a871413c6f2498c448 refs/heads/dockerShell
a346efebf0149f14d3a96a2ee90a617e540298ea refs/heads/master
ff2b5c8dc5451247d7eddfe6e20c1e7926300a80 refs/pull/100/head
cc60bb5e4b0313d7313b720c5c926bdc3de5b132 refs/pull/157/head
1881e514ee7a49c80c3f18ae49b6c199b82d9a6c refs/pull/157/merge
2f42efb8d0d91fff9b5e343dd2369ab263286f98 refs/tags/0.1.0-rc13
04f98f29534854abf1e47789ebfbc853093f1d1f refs/tags/0.1.0-rc13^{}

17. GitHub API
●
Rest (in future GraphQL)
●
Provides list of orgs, repos, branches & PRs
●
PullRequest labels, comments, etc.
●
Even Git objects (trees)
●
Conditional requests (cached connection)

18. GitHub plugin
●
Jenkins endpoint `/github-webhook/` for
incoming GitHub hooks
●
Automatic GitHub hooks registration
●
Only branches
●
GitScm Polling kick!

19. GHPRB plugin
●
The worst plugin naming for users
●
Initially global config
●
Later job level config
●
No labels support
●
Only PRs
●
Own jenkins endpoint (one more!)
●
Own credentials handling
●
Pure design based on `if` cases
●
Contribution acceptance, no cleanups

20. GitHub PullRequest Plugin
●
Rewrite from scratch
●
Extended github-plugin and reused APIs
●
Easily extend with event cases, waterfall
●
UI badges, actions, info, build/rebuild buttons
●
Polling logging
●
NO GIT lock

21. GitHub PullRequest Trigger

22. GitHub Integration Plugin
●
GitHub Branch triggering
●
Rename plugin name, but not artifact

23. Trigger modes
timeline
Internal
Information
about
remote state
remote
state
remote
state
Remote→internal
“Event”“Event”
Cause Trigger build
skip

24. Waterfall logic