-
Notifications
You must be signed in to change notification settings - Fork 1
/
developer.github.com.html
391 lines (311 loc) · 20 KB
/
developer.github.com.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
<!DOCTYPE html>
<html lang="en" prefix="og: http://ogp.me/ns#">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta http-equiv="Content-Language" content="en-us" />
<meta http-equiv="imagetoolbar" content="false" />
<meta name="robots" content="noindex">
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>GitHub Developer | GitHub Developer Guide</title>
<meta property="og:url" content="https://developer.github.com/" />
<meta property="og:site_name" content="GitHub Developer" />
<meta property="og:title" content="GitHub Developer" />
<meta property="og:description" content="Get started with one of our guides, or jump straight into the API documentation." />
<meta property="og:type" content="website" />
<meta property="og:author" content="https://www.facebook.com/GitHub" />
<meta property="og:image" content="https://og.github.com/logo/github-logo@1200x1200.png" />
<meta property="og:image:width" content="1200" />
<meta property="og:image:height" content="1200" />
<meta property="og:image" content="https://og.github.com/mark/github-mark@1200x630.png" />
<meta property="og:image:width" content="1200" />
<meta property="og:image:height" content="630" />
<meta property="og:image" content="https://og.github.com/octocat/github-octocat@1200x630.png" />
<meta property="og:image:width" content="1200" />
<meta property="og:image:height" content="630" />
<meta property="twitter:card" content="summary_large_image" />
<meta property="twitter:site" content="@github" />
<meta property="twitter:site:id" content="13334762" />
<meta property="twitter:creator" content="@githubapi" />
<meta property="twitter:creator:id" content="@539153822" />
<meta property="twitter:title" content="GitHub Developer" />
<meta property="twitter:description" content="Get started with one of our guides, or jump straight into the API documentation." />
<meta property="twitter:image:src" content="https://og.github.com/logo/github-logo@1200x1200.png" />
<meta property="twitter:image:width" content="1200" />
<meta property="twitter:image:height" content="1200" />
<link rel="alternate" type="application/atom+xml" title="API Changes" href="/changes.atom" />
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:400,300,400italic,500">
<link href="/assets/stylesheets/application.css" rel="stylesheet" type="text/css" />
<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
<script src="/assets/javascripts/application.js" type="text/javascript"></script>
</head>
<body class="overview">
<header class="site-header">
<div id="header" class="container">
<a class="site-header-logo mt-1" href="/"><img src="/assets/images/github-developer-logo.svg" alt="GitHub Developer"></a>
<nav class="site-header-nav" aria-label="Main Navigation">
<div class="dropdown" id="api-docs-dropdown">
<div class="dropdown-button" tabIndex="0" aria-haspopup="true" aria-expanded="false"><span class="dropdown-button-link" tabIndex="-1">Docs</span> <div class="dropdown-caret"></div></div>
<div id="js-dropdown-menu" class="dropdown-menu">
<a class="dropdown-menu-item" href="/apps/">Apps</a>
<a class="dropdown-menu-item" href="/actions/">GitHub Actions</a>
<a class="dropdown-menu-item" href="/marketplace/">GitHub Marketplace</a>
<a class="dropdown-menu-item" href="/webhooks/">Webhooks</a>
<a class="dropdown-menu-item" href="/partnerships/">Partnerships</a>
<a class="dropdown-menu-item" href="/v3/">REST API v3</a>
<a class="dropdown-menu-item" href="/v4/">GraphQL API v4</a>
</div>
</div>
<a class="site-header-nav-item" href="/changes/">Blog</a>
<a class="site-header-nav-item" href="/forum/">Forum</a>
<div class="dropdown" id="versions-dropdown">
<div class="dropdown-button" tabIndex="0" aria-haspopup="true" aria-expanded="false"><span class="dropdown-button-link" tabIndex="-1">Versions</span> <div class="dropdown-caret"></div></div>
<div id="js-dropdown-menu" class="dropdown-menu">
<a class="dropdown-menu-item" data-proofer-ignore>GitHub.com</a>
<a class="dropdown-menu-item" data-proofer-ignore>GitHub Enterprise Server 2.20</a>
<a class="dropdown-menu-item" data-proofer-ignore>GitHub Enterprise Server 2.19</a>
<a class="dropdown-menu-item" data-proofer-ignore>GitHub Enterprise Server 2.18</a>
</div>
</div>
<form accept-charset="UTF-8" action="#" class="site-header-nav-item site-header-search">
<label id="search-container" class="mb-0">
<input type="text" id="searchfield" class="form-control" placeholder="Search…"
autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
<div class="cancel-search"></div>
<ul id="search-results"></ul>
</label>
</form>
</nav>
</div>
</header>
<!-- hero -->
<div class="text-center bg-gray-light overflow-hidden">
<img src="../assets/images/hero-circuit-bg.svg" alt="github-circuit-board-illustration" class="hero-img">
</div><!-- /hero -->
<!-- Getting started -->
<div class="py-6 bg-custom-gradient">
<div class="container text-center">
<h1 class="text-beta">
<a id="build-your-app-on-githubs-platform" class="anchor" href="#build-your-app-on-githubs-platform" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Build your app on GitHub's platform</h1>
<p class="lead text-center mb-6">Not sure where to start? We’ve put together some handy guides and reference documentation you can use to start building.</p>
<a class="btn btn-blue" href="/v4">Learn more about v4 of the GitHub API</a>
<hr class="my-6">
</div>
<div class="container mb-4">
<div class="row clearfix">
<div class="col-xs-12 col-md-6 col-lg-8 pr-md-4">
<div class="text-gamma">Introduction to GraphQL</div>
<p class="mb-2">Let's walk through the inner workings of our GraphQL API.</p>
<p class="mb-6"><a href="/v4/guides/intro-to-graphql/" class="link-mono">Read the guide →</a></p>
<div class="text-gamma">Forming API calls with GraphQL</div>
<p class="mb-2">In this section, we're going to focus on how to form a GraphQL API call.</p>
<p class="mb-6"><a href="/v4/guides/forming-calls/" class="link-mono">Read the guide →</a></p>
<div class="text-gamma">Migrating from REST to GraphQL</div>
<p class="mb-2">We'll also help you explore the path to migrating from REST to GraphQL.</p>
<p class="mb-6"><a href="/v4/guides/migrating-from-rest/" class="link-mono">Read the guide →</a></p>
<div class="text-gamma">Building a GitHub App or an OAuth App</div>
<p class="mb-2">Choose GitHub Apps or OAuth Apps to get started developing an integration.</p>
<p class="mb-6"><a href="/apps/" class="link-mono">Read the docs →</a></p>
</div>
<div class="col-xs-12 col-md-6 col-lg-4 pl-md-5">
<div class="card">
<div class="border-bottom px-3 py-3">
<div class="text-gamma d-flex flex-items-center">
<span class="octicon octicon-telescope mega-octicon text-gray-dark mr-2"></span>Ecosystem</div>
<p class="body-sm">Showcase what you've built on GitHub</p>
</div>
<div class="border-bottom px-3 py-3">
<div class="mb-3"><a class="link-mono" href="/marketplace/">Marketplace</a></div>
<div class="mb-3"><a class="link-mono" href="/marketplace/getting-started/">Marketplace Guidelines</a></div>
</div>
<div class="px-4 py-3 text-center">
<a href="/program/">Join the GitHub Developer Program</a>
</div>
</div>
</div>
<p></p>
</div>
</div>
<div class="container">
<h2 class="text-beta text-center mt-3">
<a id="see-what-others-have-built-on-github" class="anchor" href="#see-what-others-have-built-on-github" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>See what others have built on GitHub</h2>
<p class="lead text-center pb-6">Build with tools from GitHub Marketplace.</p>
<div class="row gut-3 clearfix">
<div class="col-xs-12 col-md-6 col-lg-4">
<a class="card bg-gray-light p-4 mb-4 d-block clearfix" href="https://github.com/marketplace/circleci">
<img class="float-left rounded-1" src="../assets/images/icon-circle-ci.png" style="width: 50px;" alt="app-icon">
<div class="pl-3 float-left">
<div class="text-black text-bold mt-1">Circle CI</div>
<div class="f6 text-mono">Continuous Integration</div>
</div>
</a>
</div>
<div class="col-xs-12 col-md-6 col-lg-4">
<a class="card bg-gray-light p-4 mb-4 d-block clearfix" href="https://github.com/marketplace/zenhub">
<img class="float-left rounded-1" src="../assets/images/icon-zenhub.png" style="width: 50px;" alt="app-icon">
<div class="pl-3 float-left">
<div class="text-black text-bold mt-1">ZenHub</div>
<div class="f6 text-mono">Project Management</div>
</div>
</a>
</div>
<div class="col-xs-12 col-md-6 col-lg-4">
<a class="card bg-gray-light p-4 mb-4 d-block clearfix" href="https://github.com/marketplace/codecov">
<img class="float-left rounded-1" src="../assets/images/icon-codecov.png" style="width: 50px;" alt="app-icon">
<div class="pl-3 float-left">
<div class="text-black text-bold mt-1">Codecov</div>
<div class="f6 text-mono">Code Quality</div>
</div>
</a>
</div>
<div class="col-xs-12 col-md-6 col-lg-4">
<a class="card bg-gray-light p-4 mb-4 d-block clearfix" href="https://github.com/marketplace/rollbar">
<img class="float-left rounded-1" src="../assets/images/icon-rollbar.png" style="width: 50px;" alt="app-icon">
<div class="pl-3 float-left">
<div class="text-black text-bold mt-1">Rollbar</div>
<div class="f6 text-mono">Monitoring</div>
</div>
</a>
</div>
<div class="col-xs-12 col-md-6 col-lg-4">
<a class="card bg-gray-light p-4 mb-4 d-block clearfix" href="https://github.com/marketplace/codetree">
<img class="float-left rounded-1" src="../assets/images/icon-codetree.png" style="width: 50px;" alt="app-icon">
<div class="pl-3 float-left">
<div class="text-black text-bold mt-1">Codetree</div>
<div class="f6 text-mono">Project Management</div>
</div>
</a>
</div>
<div class="col-xs-12 col-md-6 col-lg-4">
<a class="card bg-gray-light p-4 mb-4 d-block clearfix" href="https://github.com/marketplace/appveyor">
<img class="float-left rounded-1" src="../assets/images/icon-appveyor.png" style="width: 50px;" alt="app-icon">
<div class="pl-3 float-left">
<div class="text-black text-bold mt-1">Appveyor</div>
<div class="f6 text-mono">Continuous Integration</div>
</div>
</a>
</div>
</div>
<div class="text-center mt-4 mb-5">
<a class="btn-outline btn" href="http://github.com/marketplace">Browse GitHub Marketplace</a>
</div>
</div>
<div class="bg-shade-gradient pt-6">
<div class="container">
<h2 class="text-beta text-center mt-3">
<a id="stay-in-the-know" class="anchor" href="#stay-in-the-know" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Stay in the know</h2>
<p class="lead text-center mb-6">Keep up to date with the latest updates to the GitHub API</p>
<div class="card">
<div class="p-4 border-bottom">
<span class="text-mono bg-blue text-white px-3 pt-1 rounded-1 float-right d-block">New</span>
<a class="text-gamma pr-6 d-block" href="/changes/2020-05-15-actions-api-workflow-usage/">GitHub Actions API - Introducing workflow usage endpoints</a>
<span class="text-mono text-small mr-2"><span class="octicon octicon-calendar text-gray-light mr-1" style="margin-top: -3px;"></span>May 15, 2020</span>
<span class="text-mono text-small mr-2">
<span class="octicon text-gray-light mr-1" style="margin-top: -3px;"></span><img height="16" width="16" src="https://github.com/gimenete.png" alt="Avatar for gimenete" data-proofer-ignore> <a class="link-gray" href="https://github.com/gimenete" data-proofer-ignore>gimenete</a>
</span>
</div>
<div class="p-4 border-bottom">
<a class="text-gamma pr-6 text-gray-dark d-block" style="opacity: 0.8;" href="/changes/2020-05-08-skipped-conclusion/">Introducing the skipped check run and check suite conclusion</a>
<span class="text-mono text-small mr-2"><span class="octicon octicon-calendar text-gray-light mr-1" style="margin-top: -3px;"></span>May 8, 2020</span>
<span class="text-mono text-small mr-2">
<span class="octicon text-gray-light mr-1" style="margin-top: -3px;"></span><img height="16" width="16" src="https://github.com/joshmgross.png" alt="Avatar for joshmgross" data-proofer-ignore> <a class="link-gray" href="https://github.com/joshmgross" data-proofer-ignore>joshmgross</a>
</span>
</div>
<div class="p-4 border-bottom">
<a class="text-gamma pr-6 text-gray-dark d-block" style="opacity: 0.8;" href="/changes/2020-05-01-suspending-a-github-app-installation/">Suspending GitHub App installations</a>
<span class="text-mono text-small mr-2"><span class="octicon octicon-calendar text-gray-light mr-1" style="margin-top: -3px;"></span>May 1, 2020</span>
<span class="text-mono text-small mr-2">
<span class="octicon text-gray-light mr-1" style="margin-top: -3px;"></span><img height="16" width="16" src="https://github.com/tarebyte.png" alt="Avatar for tarebyte" data-proofer-ignore> <a class="link-gray" href="https://github.com/tarebyte" data-proofer-ignore>tarebyte</a>
</span>
</div>
<div class="p-4 border-bottom">
<a class="text-gamma pr-6 text-gray-dark d-block" style="opacity: 0.8;" href="/changes/2020-04-30-expiring-user-to-server-access-tokens-for-github-apps/">Expiring user-to-server access tokens for GitHub Apps</a>
<span class="text-mono text-small mr-2"><span class="octicon octicon-calendar text-gray-light mr-1" style="margin-top: -3px;"></span>April 30, 2020</span>
<span class="text-mono text-small mr-2">
<span class="octicon text-gray-light mr-1" style="margin-top: -3px;"></span><img height="16" width="16" src="https://github.com/jakewilkins.png" alt="Avatar for jakewilkins" data-proofer-ignore> <a class="link-gray" href="https://github.com/jakewilkins" data-proofer-ignore>jakewilkins</a>
</span>
</div>
<div class="p-4 border-bottom">
<a class="text-gamma pr-6 text-gray-dark d-block" style="opacity: 0.8;" href="/changes/2020-04-15-replacing-create-installation-access-token-endpoint/">Replacing the GitHub Apps "Creating an installation access token" endpoint</a>
<span class="text-mono text-small mr-2"><span class="octicon octicon-calendar text-gray-light mr-1" style="margin-top: -3px;"></span>April 15, 2020</span>
<span class="text-mono text-small mr-2">
<span class="octicon text-gray-light mr-1" style="margin-top: -3px;"></span><img height="16" width="16" src="https://github.com/jamesmartin.png" alt="Avatar for jamesmartin" data-proofer-ignore> <a class="link-gray" href="https://github.com/jamesmartin" data-proofer-ignore>jamesmartin</a>
</span>
<span class="text-mono text-small mr-2">
<span class="octicon text-gray-light mr-1" style="margin-top: -3px;"></span><img height="16" width="16" src="https://github.com/jakewilkins.png" alt="Avatar for jakewilkins" data-proofer-ignore> <a class="link-gray" href="https://github.com/jakewilkins" data-proofer-ignore>jakewilkins</a>
</span>
</div>
<div class="p-4 border-bottom">
<a class="text-gamma pr-6 text-gray-dark d-block" style="opacity: 0.8;" href="/changes/2020-04-15-replacing-the-installation-and-installation-repositories-events/">Replacing the integration_installation and integration_installation_repositories webhook events</a>
<span class="text-mono text-small mr-2"><span class="octicon octicon-calendar text-gray-light mr-1" style="margin-top: -3px;"></span>April 15, 2020</span>
<span class="text-mono text-small mr-2">
<span class="octicon text-gray-light mr-1" style="margin-top: -3px;"></span><img height="16" width="16" src="https://github.com/jakewilkins.png" alt="Avatar for jakewilkins" data-proofer-ignore> <a class="link-gray" href="https://github.com/jakewilkins" data-proofer-ignore>jakewilkins</a>
</span>
<span class="text-mono text-small mr-2">
<span class="octicon text-gray-light mr-1" style="margin-top: -3px;"></span><img height="16" width="16" src="https://github.com/jamesmartin.png" alt="Avatar for jamesmartin" data-proofer-ignore> <a class="link-gray" href="https://github.com/jamesmartin" data-proofer-ignore>jamesmartin</a>
</span>
</div>
</div>
</div>
</div>
<div class="bg-blue py-3 mt-6 text-white" style="margin-bottom:-30px;">
<div class="container">
<div class="row clearfix" style="width: 100%;">
<div class="col-xs-12 col-12 col-md-6 py-3 d-xs-block">
<div class="text-gamma pt-1 mb-0 text-white">Never miss an update!</div>
<p class="mb-0 text-small" style="color: rgba(255,255,255,.7);">Join the newsletter to be informed of every new update.</p>
</div>
<div class="col-xs-12 col-12 col-md-6 py-3 text-right d-xs-block">
<div id="mc_embed_signup">
<form action="//github.us11.list-manage.com/subscribe/post?u=9d7ced8c4bbd6c2f238673f0f&id=7d9164de9f" method="post" id="mc-embedded-subscribe-form" name="mc-embedded-subscribe-form" class="validate mt-md-2" target="_blank" novalidate>
<div class="row clearfix gut-3">
<div class="col-12 col-md-8">
<div class="mc-field-group mb-3 mb-md-3">
<input type="email" value="" name="EMAIL" class="required email form-control d-block" id="mce-EMAIL" placeholder="Your email" style="height: 42px; width: 100%;">
</div>
</div>
<div class="col-12 col-md-4">
<div class="clear">
<input type="submit" value="Join" name="subscribe" id="mc-embedded-subscribe" class="btn btn-blue ml-0 text-center btn-block d-block">
</div>
</div>
</div>
<div id="mce-responses" class="clear clearfix text-small" style="color: rgba(255,255,255,.7);">
<div class="response mt-3" id="mce-error-response" style="display:none"></div>
<div class="response mt-3" id="mce-success-response" style="display:none"></div>
</div>
<!-- real people should not fill this in and expect good things - do not remove this or risk form bot signups-->
<div style="position: absolute; left: -5000px;" aria-hidden="true">
<input type="text" name="b_9d7ced8c4bbd6c2f238673f0f_7d9164de9f" tabindex="-1" value="">
</div>
</form>
</div>
<script type="text/javascript" src="//s3.amazonaws.com/downloads.mailchimp.com/js/mc-validate.js"></script>
</div>
</div>
</div>
</div>
<p></p>
</div>
<footer class="footer text-muted">
<div class="container">
<span class="footer-legal">© 2020 GitHub Inc. All rights reserved.</span>
<span class="mega-octicon octicon-mark-github footer-mark"></span>
<nav class="footer-nav">
<a class="footer-nav-item" href="https://help.github.com/articles/github-terms-of-service">Terms of service</a>
<a class="footer-nav-item" href="https://github.com/site/privacy">Privacy</a>
<a class="footer-nav-item" href="https://github.com/security">Security</a>
<a class="footer-nav-item" href="https://github.com/support">Support</a>
</nav>
</div>
</footer>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-3769691-37', 'github.com');
ga('send', 'pageview');
</script>
</body>
</html>