@@ -36,11 +36,13 @@ repositories](https://help.github.com/post-receive-hooks/). This trigger
36
36
only kicks git-plugin internal polling algo for every incoming event
37
37
against matched repo.
38
38
39
- Old name
39
+ > This plugin was previously named as "Build when a change is pushed to GitHub"
40
40
41
- Previously named as "Build when a change is pushed to GitHub"
41
+ ## Usage
42
42
43
- To be able to use this feature:
43
+ To be able to use this feature different mode are available :
44
+ * manual mode : the url have to be added manually in each project
45
+ * automatic mode : Jenkins register automatically the webhook for every project
44
46
45
47
### Manual Mode
46
48
@@ -73,24 +75,24 @@ Login and Password to token**
73
75
74
76
![ ] ( /docs/images/manage-token.png )
75
77
76
- Two-Factor Authentication
77
-
78
- Auto-creating token doesn't work with [ GitHub
79
- 2FA] ( https://help.github.com/articles/about-two-factor-authentication/ )
80
-
81
- You can create ** "Secret text"** credentials with token in corresponding
82
- domain with login and password directly, or from username and password
83
- credentials.
78
+ > * Two-Factor Authentication*
79
+ >
80
+ > Auto-creating token doesn't work with [ GitHub
81
+ > 2FA] ( https://help.github.com/articles/about-two-factor-authentication/ )
82
+ >
83
+ > You can create ** "Secret text"** credentials with token in corresponding
84
+ > domain with login and password directly, or from username and password
85
+ > credentials.
84
86
85
87
** Step 2.2.** Select previously created "Secret Text" credentials with
86
88
GitHub OAuth token.
87
89
88
- Required scopes for token
90
+ * Required scopes for token*
89
91
90
92
To be able manage hooks your token should have ** admin: org \_ hook**
91
93
scope.
92
94
93
- GitHub Enterprise
95
+ * GitHub Enterprise*
94
96
95
97
You can also redefine GitHub url by clicking on ** Custom GitHub API
96
98
URL** checkbox.
@@ -110,23 +112,23 @@ for all your repositories. The server side of this URL is smart enough
110
112
to figure out which projects need to be triggered, based on the
111
113
submission.
112
114
113
- #### Security Implications
115
+ ## Security Implications
114
116
115
117
This plugin requires that you have an HTTP URL reachable from GitHub,
116
118
which means it's reachable from the whole internet. So it is implemented
117
119
carefully with the possible malicious fake post-receive POSTS in mind.
118
120
To cope with this, upon receiving a POST, Jenkins will talk to GitHub to
119
121
ensure the push was actually made.
120
122
121
- #### Jenkins inside a firewall
123
+ ## Jenkins inside a firewall
122
124
123
125
In case your Jenkins run inside the firewall and not directly reachable
124
126
from the internet, this plugin lets you specify an arbitrary endpoint
125
127
URL as an override in the automatic mode. The plugin will assume that
126
128
you've set up reverse proxy or some other means so that the POST from
127
129
GitHub will be routed to the Jenkins.
128
130
129
- #### Trouble-shooting hooks
131
+ ## Trouble-shooting hooks
130
132
131
133
If you set this up but build aren't triggered, check the following
132
134
things:
@@ -146,7 +148,7 @@ things:
146
148
- Click "Test hook" button from the GitHub UI and see if Jenkins
147
149
receive a payload.
148
150
149
- #### Using cache to GitHub requests
151
+ ## Using cache to GitHub requests
150
152
151
153
Each ** GitHub Server Config** creates own GitHub client to interact with
152
154
api. By default it uses cache (with ** 20MB** limit) to speedup process
@@ -183,7 +185,7 @@ Additional info:
183
185
184
186
## Pipeline examples
185
187
186
- #### Setting commit status
188
+ ### Setting commit status
187
189
188
190
This code will set commit status for custom repo with configured context
189
191
and message (you can also define same way backref)
0 commit comments