10000 Merge pull request #238 from gmembre-zenika/patch-1 · srbala/github-plugin@e787c48 · GitHub
[go: up one dir, main page]

Skip to content

Commit e787c48

Browse files
authored
Merge pull request jenkinsci#238 from gmembre-zenika/patch-1
Adjust the level of chapters
2 parents 4b9f18d + 987a523 commit e787c48

File tree

1 file changed

+20
-18
lines changed

1 file changed

+20
-18
lines changed

README.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,13 @@ repositories](https://help.github.com/post-receive-hooks/). This trigger
3636
only kicks git-plugin internal polling algo for every incoming event
3737
against matched repo.
3838

39-
Old name
39+
> This plugin was previously named as "Build when a change is pushed to GitHub"
4040
41-
Previously named as "Build when a change is pushed to GitHub"
41+
## Usage
4242

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
4446

4547
### Manual Mode
4648

@@ -73,24 +75,24 @@ Login and Password to token**
7375

7476
![](/docs/images/manage-token.png)
7577

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.
8486
8587
**Step 2.2.** Select previously created "Secret Text" credentials with
8688
GitHub OAuth token.
8789

88-
Required scopes for token
90+
*Required scopes for token*
8991

9092
To be able manage hooks your token should have **admin:org\_hook**
9193
scope.
9294

93-
GitHub Enterprise
95+
*GitHub Enterprise*
9496

9597
You can also redefine GitHub url by clicking on **Custom GitHub API
9698
URL** checkbox.
@@ -110,23 +112,23 @@ for all your repositories. The server side of this URL is smart enough
110112
to figure out which projects need to be triggered, based on the
111113
submission.
112114

113-
#### Security Implications
115+
## Security Implications
114116

115117
This plugin requires that you have an HTTP URL reachable from GitHub,
116118
which means it's reachable from the whole internet. So it is implemented
117119
carefully with the possible malicious fake post-receive POSTS in mind.
118120
To cope with this, upon receiving a POST, Jenkins will talk to GitHub to
119121
ensure the push was actually made.
120122

121-
#### Jenkins inside a firewall
123+
## Jenkins inside a firewall
122124

123125
In case your Jenkins run inside the firewall and not directly reachable
124126
from the internet, this plugin lets you specify an arbitrary endpoint
125127
URL as an override in the automatic mode. The plugin will assume that
126128
you've set up reverse proxy or some other means so that the POST from
127129
GitHub will be routed to the Jenkins.
128130

129-
#### Trouble-shooting hooks
131+
## Trouble-shooting hooks
130132

131133
If you set this up but build aren't triggered, check the following
132134
things:
@@ -146,7 +148,7 @@ things:
146148
- Click "Test hook" button from the GitHub UI and see if Jenkins
147149
receive a payload.
148150

149-
#### Using cache to GitHub requests
151+
## Using cache to GitHub requests
150152

151153
Each **GitHub Server Config** creates own GitHub client to interact with
152154
api. By default it uses cache (with **20MB** limit) to speedup process
@@ -183,7 +185,7 @@ Additional info:
183185

184186
## Pipeline examples
185187

186-
#### Setting commit status
188+
### Setting commit status
187189

188190
This code will set commit status for custom repo with configured context
189191
and message (you can also define same way backref)

0 commit comments

Comments
 (0)
0