diff --git a/docs/sources/docker-hub/builds.md b/docs/sources/docker-hub/builds.md index 3d8159b451..3e323af3c8 100644 --- a/docs/sources/docker-hub/builds.md +++ b/docs/sources/docker-hub/builds.md @@ -1,41 +1,43 @@ page_title: Automated Builds on Docker Hub page_description: Docker Hub Automated Builds page_keywords: Docker, docker, registry, accounts, plans, Dockerfile, Docker Hub, docs, documentation, trusted, builds, trusted builds, automated builds + # Automated Builds on Docker Hub ## About Automated Builds -*Automated Builds* are a special feature of Docker Hub which allow you to use -[Docker Hub's](https://hub.docker.com) build clusters to automatically create images from -a specified `Dockerfile` and a GitHub or Bitbucket repo (or "context"). The system will -clone your repository and build the image described by the `Dockerfile` using the -repository as the context. The resulting automated image will then be uploaded to the -Docker Hub registry and marked as an *Automated Build*. +*Automated Builds* are a special feature of Docker Hub which allow you to +use [Docker Hub's](https://hub.docker.com) build clusters to automatically +create images from a specified `Dockerfile` and a GitHub or Bitbucket repo +(or "context"). The system will clone your repository and build the image +described by the `Dockerfile` using the repository as the context. The +resulting automated image will then be uploaded to the Docker Hub registry +and marked as an *Automated Build*. Automated Builds have several advantages: -* Users of *your* Automated Build can trust that the resulting image was built exactly as -specified. +* Users of *your* Automated Build can trust that the resulting +image was built exactly as specified. -* The `Dockerfile` will be available to anyone with access to your repository -on the Docker Hub registry. +* The `Dockerfile` will be available to anyone with access to +your repository on the Docker Hub registry. -* Because the process is automated, Automated Builds help to make sure that your -repository is always up to date. +* Because the process is automated, Automated Builds help to +make sure that your repository is always up to date. -Automated Builds are supported for both public and private repositories on both -[GitHub](http://github.com) and [Bitbucket](https://bitbucket.org/). +Automated Builds are supported for both public and private repositories +on both [GitHub](http://github.com) and [Bitbucket](https://bitbucket.org/). -To use Automated Builds, you must have an -[account on Docker Hub](http://docs.docker.com/userguide/dockerhub/#creating-a-docker-hub-account) -and on GitHub and/or Bitbucket. In either case, the account needs to be properly -validated and activated before you can link to it. +To use Automated Builds, you must have an [account on Docker Hub]( +http://docs.docker.com/userguide/dockerhub/#creating-a-docker-hub-account) +and on GitHub and/or Bitbucket. In either case, the account needs +to be properly validated and activated before you can link to it. ## Setting up Automated Builds with GitHub In order to set up an Automated Build, you need to first link your -[Docker Hub](https://hub.docker.com) account with a GitHub account. This -will allow the registry to see your repositories. +[Docker Hub](https://hub.docker.com) account with a GitHub account. +This will allow the registry to see your repositories. > *Note:* > Automated Builds currently require *read* and *write* access since @@ -43,26 +45,32 @@ will allow the registry to see your repositories. > hook. We have no choice here, this is how GitHub manages permissions, sorry! > We do guarantee nothing else will be touched in your account. -To get started, log into your Docker Hub account and click the "+ Add Repository" button -at the upper right of the screen. Then select +To get started, log into your Docker Hub account and click the +"+ Add Repository" button at the upper right of the screen. Then select [Automated Build](https://registry.hub.docker.com/builds/add/). Select the [GitHub service](https://registry.hub.docker.com/associate/github/). -Then follow the onscreen instructions to authorize and link your GitHub account to Docker -Hub. Once it is linked, you'll be able to choose a repo from which to create the -Automatic Build. +Then follow the onscreen instructions to authorize and link your +GitHub account to Docker Hub. Once it is linked, you'll be able to +choose a repo from which to create the Automatic Build. ### Creating an Automated Build -You can [create an Automated Build](https://registry.hub.docker.com/builds/github/select/) -from any of your public or private GitHub repositories with a `Dockerfile`. +You can [create an Automated Build]( +https://registry.hub.docker.com/builds/github/select/) from any of your +public or private GitHub repositories with a `Dockerfile`. -### Github Submodules +### GitHub Submodules -If your repository contains links to private submodules, you'll need to add a deploy key so that the Docker Hub will be able to clone the repository from GitHub. +If your repository contains links to private submodules, you'll +need to add a deploy key so that the Docker Hub will be able to +clone the repository from GitHub. -Your Docker Hub deploy key is located under the "Build Details" menu on the automated build's main page in the Hub. Add this key to your GitHub submodule by viewing the Settings page for the repository on GitHub and selecting "Deploy keys". +Your Docker Hub deploy key is located under the "Build Details" +menu on the automated build's main page in the Hub. Add this key +to your GitHub submodule by viewing the Settings page for the +repository on GitHub and selecting "Deploy keys".