kotovalexarian-likes-github
/
moby--moby
mirror of https://github.com/moby/moby.git
1
0
Fork 0
Code Releases Activity

Webhooks documentation: second pass addressing @fredlf's comments 

Signed-off-by: Joffrey F <joffrey@docker.com>
This commit is contained in:
Joffrey F 2014-12-02 13:42:04 -08:00
parent 906c7211e6
commit bcef353557
2 changed files with 17 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/sources/docker-hub/repos.md
View File

@ -140,12 +140,18 @@ similar to the example shown below.
}
Webhooks allow you to notify people, services and other applications of
new updates to your images and repositories.
new updates to your images and repositories. To get started adding webhooks,
go to the desired repo in the Hub, and click "Webhooks" under the "Settings"
box.
### Webhook chains
Webhook chains allow you to chain calls to multiple services. After clicking the
"Add webhook" button, simply add as many URLs as necessary in your chain.
Webhook chains allow you to chain calls to multiple services. For example,
you can use this to trigger a deployment of your container only after
it has been successfully tested, then update a separate Changelog once the
deployment is complete.
After clicking the "Add webhook" button, simply add as many URLs as necessary
in your chain.
The first webhook in a chain will be called after a successful push. Subsequent URLs will be contacted after the callback has been validated.
@ -159,9 +165,12 @@ In order to validate a callback in a webhook chain, you need to
> **Note**: A chain request will only be considered complete once the last
> callback has been validated.
To help you debug or simply view the results of your webhook(s),
view the "History" of the webhook available on its settings page.
#### Callback JSON data
Recognized parameters in callback data are as follow:
The following parameters are recognized in callback data:
* `state` (required): Accepted values are `success`, `failure` and `error`. If the state isn't `success`, the webhook chain will be interrupted.
* `description`: A string containing miscellaneous information that will be available on the Docker Hub. Maximum 255 characters.

8
docs/sources/userguide/dockerrepos.md
View File

@ -24,12 +24,12 @@ Docker itself provides access to Docker Hub services via the `docker search`,
### Account creation and login
Typically, you'll want to start by creating an account on Docker Hub (if you haven't
already) and logging in. You can create your account directly on
already) and logging in. You can create your account directly on
[Docker Hub](https://hub.docker.com/account/signup/), or by running:
$ sudo docker login
This will prompt you for a user name, which will become the public namespace for your
This will prompt you for a user name, which will become the public namespace for your
public repositories.
If your user name is available, Docker will prompt you to enter a password and your
e-mail address. It will then automatically log you in. You can now commit and
@ -162,8 +162,8 @@ event when an image or updated image is pushed to the repository. With
a webhook you can specify a target URL and a JSON payload that will be
delivered when the image is pushed.
See more information on webhooks
[here](http://docs.docker.com/docker-hub/repos/#webhooks)
See the Docker Hub documentation for [more information on
webhooks](http://docs.docker.com/docker-hub/repos/#webhooks)
## Next steps