New screenshots and revisions to builds.md

Docker-DCO-1.1-Signed-off-by: Fred Lifton <fred.lifton@docker.com> (github: fredlf)
This commit is contained in:
Fred Lifton 2014-07-09 16:43:39 -07:00
parent 27c34f3eb9
commit ce9d48e896
5 changed files with 30 additions and 28 deletions

View File

@ -77,13 +77,16 @@ Automated Build:
<tbody> <tbody>
<tr> <tr>
<td>1.</td> <td>1.</td>
<td><img src="https://d207aa93qlcgug.cloudfront.net/0.8/img/github_settings.png"></td> <td><img src="/docker-hub/hub-images/gh_settings.png"></td>
<td>Log in to Github.com, and visit your Repository page. Click on repository "Settings" on the right side of the page. You must have admin privileges to the repository in order to do this.</td> <td>Log in to Github.com, and go to your Repository page. Click on "Settings" on
the right side of the page. You must have admin privileges to the repository in order to do this.</td>
</tr> </tr>
<tr> <tr>
<td>2.</td> <td>2.</td>
<td><img src="https://d207aa93qlcgug.cloudfront.net/0.8/img/github_service_hooks.png" alt="Service Hooks"></td> <td><img src="/docker-hub/hub-images/gh_menu.png" alt="Webhooks & Services"></td>
<td>Click on "Webhooks & Services" on the left side of the page.</td></tr><tr><td>3.</td><td><img src="https://d207aa93qlcgug.cloudfront.net/0.8/img/github_docker_service_hook.png" alt="Find the service labeled Docker"></td><td>Find the service labeled "Docker" and click on it.</td></tr><tr><td>4.</td><td><img src="https://d207aa93qlcgug.cloudfront.net/0.8/img/github_service_hook_docker_activate.png" alt="Activate Service Hooks"></td> <td>Click on "Webhooks & Services" on the left side of the page.</td></tr>
<tr><td>3.</td><td><img src="/docker-hub/hub-images/gh_service_hook.png" alt="Find the service labeled Docker"></td><td>Find the service labeled "Docker" and click on it.</td></tr>
<tr><td>4.</td><td><img src="/docker-hub/hub-images/gh_docker-service.png" alt="Activate Service Hooks"></td>
<td>Make sure the "Active" checkbox is selected and click the "Update service" button to save your changes.</td> <td>Make sure the "Active" checkbox is selected and click the "Update service" button to save your changes.</td>
</tr> </tr>
</tbody> </tbody>
@ -112,42 +115,42 @@ public or private Bitbucket repositories with a `Dockerfile`.
## The Dockerfile and Automated Builds ## The Dockerfile and Automated Builds
During the build process, we copy the contents of your `Dockerfile`. We also During the build process, Docker will copy the contents of your `Dockerfile`. It will
add it to the [Docker Hub](https://hub.docker.com) for the Docker community (for public also add it to the [Docker Hub](https://hub.docker.com) for the Docker community (for
repos) or approved team members/orgs (for private repos) to see on the repository page public repos) or approved team members/orgs (for private repos) to see on the repository
(if your repo is public). page.
## README.md ## README.md
If you have a `README.md` file in your repository, it will be used as the If you have a `README.md` file in your repository, it will be used as the
repository's full description. repository's full description.The build process will look for a
`README.md` in the same directory as your `Dockerfile`.
> **Warning:** > **Warning:**
> If you change the full description after a build, it will be > If you change the full description after a build, it will be
> rewritten the next time the Automated Build has been built. To make changes, > rewritten the next time the Automated Build has been built. To make changes,
> modify the `README.md` from the Git repository. The build process will look for a > modify the `README.md` from the Git repository.
> `README.md` in the same directory as your `Dockerfile`.
### Build triggers ### Build triggers
If you need a way to trigger Automated Builds outside of GitHub If you need a way to trigger Automated Builds outside of GitHub
or Bitbucket, you can set up a build trigger. When you turn on the build or Bitbucket, you can set up a build trigger. When you turn on the build
trigger for an Automated Build, it will give you a URL to which you can trigger for an Automated Build, it will give you a URL to which you can
send POST requests. This will trigger the Automated Build, which send POST requests. This will trigger the Automated Build, much as with a GitHub webhook.
is similar to GitHub webhooks.
Build triggers are available under the Settings tab of each Automated Build. Build triggers are available under the Settings menu of each Automated Build repo on the
Docker Hub.
> **Note:** > **Note:**
> You can only trigger one build at a time and no more than one > You can only trigger one build at a time and no more than one
> every five minutes. If you have a build already pending, or if you already > every five minutes. If you already have a build pending, or if you
> recently submitted a build request, those requests *will be ignored*. > recently submitted a build request, those requests *will be ignored*.
> You can find the logs of last 10 triggers on the settings page to verify > To verify everything is working correctly, check the logs of last ten triggers on the
> if everything is working correctly. settings page .
### Webhooks ### Webhooks
Also available for Automated Builds are Webhooks. Webhooks can be called Automated Builds also include a Webhooks feature. Webhooks can be called
after a successful repository push is made. after a successful repository push is made.
The webhook call will generate a HTTP POST with the following JSON The webhook call will generate a HTTP POST with the following JSON
@ -184,24 +187,23 @@ payload:
} }
``` ```
Webhooks are available under the Settings tab of each Automated Webhooks are available under the Settings menu of each Automated
Build. Build's repo.
> **Note:** If you want to test your webhook out then we recommend using > **Note:** If you want to test your webhook out we recommend using
> a tool like [requestb.in](http://requestb.in/). > a tool like [requestb.in](http://requestb.in/).
### Repository links ### Repository links
Repository links are a way to associate one Automated Build with another. If one Repository links are a way to associate one Automated Build with another. If one
gets updated, linking system also triggers a build for the other Automated Build. gets updated,the linking system triggers a rebuild for the other Automated Build.
This makes it easy to keep your Automated Builds up to date. This makes it easy to keep all your Automated Builds up to date.
To add a link, go to the settings page of an Automated Build and click on To add a link, go to the repo for the Automated Build you want to link to and click on
*Repository Links*. Then enter the name of the repository that you want have *Repository Links* under the Settings menu at right. Then, enter the name of the repository that you want have linked.
linked.
> **Warning:** > **Warning:**
> You can add more than one repository link, however, you should > You can add more than one repository link, however, you should
> be very careful. Creating a two way relationship between Automated Builds will > do so very carefully. Creating a two way relationship between Automated Builds will
> cause a never ending build loop. > cause an endless build loop.

Binary file not shown.

After

Width:  |  Height:  |  Size: 126 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB