Commit5bcb112

committed

add page build event

1 parenta6d39b9 commit5bcb112Copy full SHA for 5bcb112

File tree

+32

-1

lines changed

+32

-1

lines changed

Lines changed: 14 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,14 @@`
	`1`	`+---`
	`2`	`+kind:change`
	`3`	`+title:Page Build Event for Webhooks`
	`4`	`+created_at:2014-3-12`
	`5`	`+author_name:benbalter`
	`6`	`+---`
	`7`	`+`
	`8`	+We've made it even easier to track the status of your[GitHub Pages](http://pages.github.com/) builds. By subscribing to the new[`page_build`](/v3/activity/events/types/#pagebuildevent) event, your application will receive an event payload containing the results of each build. (As always, these builds occur automatically following each push to a GitHub Pages-enabled branch.)
	`9`	`+`
	`10`	+If you have a[webhook](/webhooks/) with the["send me everything" option](https://github.com/blog/1778-webhooks-level-up) selected (or if you use the "[wildcard event](/changes/2014-02-24-wildcard-event-for-webhooks/)" via the API), you will receive the`page_build` event after the next build of your GitHub Pages site. Alternatively, if you prefer to subscribe to specific event types, you can add to the new`page_build` event to your webhooks via your repository's webhook settings page or via the[webhooks API](/v3/repos/hooks/).
	`11`	`+`
	`12`	`+For more information, be sure to check out our guide on[working with webhooks](/webhooks/). If you have any questions or feedback, please[drop us a line][contact].`
	`13`	`+`
	`14`	`+[contact]:https://github.com/contact?form%5Bsubject%5D=API+Page+Build+Event`

Lines changed: 16 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -405,3 +405,19 @@ event’s repository is the [repository](/v3/repos/) that was starred.`
`405`	`405`	`Key \| Type \| Description`
`406`	`406`	`----\|------\|-------------`
`407`	`407`	`action`\|`string` \| The action that was performed. Currently, can only be`started`.
	`408`	`+`
	`409`	`+##PageBuildEvent`
	`410`	`+`
	`411`	`+Represents an attempted build of a GitHub Pages site, whether successful or not.`
	`412`	`+`
	`413`	+Triggered on push to a GitHub Pages enabled branch (`gh-pages` for project pages,`master` for user and organization pages).
	`414`	`+`
	`415`	`+###Hook Name`
	`416`	`+`
	`417`	+`page_build`
	`418`	`+`
	`419`	`+###Payload`
	`420`	`+`
	`421`	`+Key \| Type \| Description`
	`422`	`+----\|------\|------------`
	`423`	+`build` \|`object` \| The[page build](http://developer.github.com/v3/repos/pages/#list-pages-builds) itself.

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -77,9 +77,9 @@ Name \| Description`
`77`	`77`	`status` \| Any time a Repository has a status update from the API
`78`	`78`	`deployment` \| Any time a Repository has a new deployment created from the API.
`79`	`79`	`deployment_status` \| Any time a deployment for the Repository has a status update from the API.
	`80`	+`page_build` \| Any time a Pages site is built or results in a failed build.
`80`	`81`	`*` \| Any time any event is triggered ([Wildcard Event](#wildcard-event)).
`81`	`82`
`82`		`-`
`83`	`83`	`###Payloads`
`84`	`84`
`85`	`85`	`The payloads for all hooks mirror[the payloads for the Event`

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,7 @@ module Helpers`
`45`	`45`	`:izuzak=>'ff743b4cba28cc47ad65cb90212c1e51',`
`46`	`46`	`:spicycode=>'7ce90d712fab09421b7f2cf955b9a4c8',`
`47`	`47`	`:dbussink=>'b012094b37ab6946c44eaa41d7828478',`
	`48`	`+:benbalter=>'19d03ecc1ff5da1a5e63a3ddaa2d84c2',`
`48`	`49`	`}`
`49`	`50`
`50`	`51`	`DefaultTimeFormat="%B %-d, %Y".freeze`

Comments

(0)