Hub autobuild doc cleanup and updates (#9864)
* instruction and screenshot updates Signed-off-by: Lena Larionova <lena.larionova@docker.com> * removed one more mention of sourceref Signed-off-by: Lena Larionova <lena.larionova@docker.com>
|
@ -1230,7 +1230,7 @@ reference:
|
|||
- path: /registry/spec/auth/scope/
|
||||
title: Token scope documentation
|
||||
- path: /registry/spec/auth/token/
|
||||
title: Token authentication specification
|
||||
title: Token authentication specification
|
||||
- sectiontitle: Registry storage drivers
|
||||
section:
|
||||
- path: /registry/storage-drivers/
|
||||
|
@ -3966,8 +3966,6 @@ manuals:
|
|||
title: Advanced automated builds
|
||||
- path: /docker-hub/builds/link-source/
|
||||
title: Link to GitHub and BitBucket
|
||||
- path: /docker-hub/builds/classic/
|
||||
title: Classic automated builds
|
||||
- sectiontitle: Publisher & certified content
|
||||
section:
|
||||
- path: /docker-hub/publish/
|
||||
|
|
|
@ -1,90 +0,0 @@
|
|||
---
|
||||
description: Explains the difference between Classic and new Automated Builds
|
||||
keywords: automated, build, images
|
||||
title: Classic Automated Builds
|
||||
---
|
||||
|
||||
With the launch of the new Docker Hub, we are introducing an improved Automated Build experience.
|
||||
|
||||
Automated Builds created using an older version of Docker Hub are now labelled "Classic".
|
||||
If you were using Docker Cloud to manage builds, your builds are already the latest version of Automated Builds.
|
||||
|
||||
All automated builds created going forward will get the new experience. If you are creating a new
|
||||
Automated Build for the first time, see [docs](/docker-hub/builds.md#configure-automated-build-settings).
|
||||
|
||||
In the coming months, we will gradually convert Classic Automated Builds into new Automated Builds. This should
|
||||
be a seamless process for most users.
|
||||
|
||||
|
||||
## Managing Classic Automated Builds
|
||||
|
||||
You can manage both Classic and new Automated Builds from the **Builds** tab
|
||||
|
||||
Repository with Classic Automated Build:
|
||||
|
||||

|
||||
|
||||
Build settings can be configured similarly to those on the old Docker Hub.
|
||||
|
||||
If you have previously created an automated build in both the old Docker Hub and Docker Cloud, you can switch between
|
||||
Classic and new Automated Builds.
|
||||
|
||||
New Automated Build is displayed by default. You can switch to Classic Automated Build by clicking on this link at the top
|
||||
|
||||

|
||||
|
||||
Likewise, you can switch back to new Automated Build by clicking on this link at the top
|
||||
|
||||

|
||||
|
||||
|
||||
|
||||
## Adding Github webhook manually
|
||||
|
||||
A GitHub webhook allows GitHub to notify Docker Hub when something has
|
||||
been committed to a given Git repository.
|
||||
|
||||
When you create a Classic Automated Build, a webhook should get automatically added to your GitHub
|
||||
repository.
|
||||
|
||||
To add, confirm, or modify the webhook, log in to GitHub, then navigate to
|
||||
the repository. Within the repository, select **Settings > Webhooks**.
|
||||
You must have admin privileges on the repository to view or modify
|
||||
this setting. Click **Add webhook**, and use the following settings:
|
||||
|
||||
|
||||
| Field | Value |
|
||||
| ------|------ |
|
||||
| Payload URL | https://registry.hub.docker.com/hooks/github |
|
||||
| Content type | application/json |
|
||||
| Which events would you like to trigger this webhook? | Just the push event |
|
||||
| Active | checked |
|
||||
|
||||
The image below shows the **Webhooks/Add webhook** form with the above settings reflected:
|
||||
|
||||

|
||||
|
||||
If configured correctly, you'll see this in the **Webhooks** view
|
||||

|
||||
|
||||
|
||||
|
||||
## Frequently Asked Questions
|
||||
|
||||
|
||||
**Q: I've previously linked my GitHub/Bitbucket account in the old Docker Hub. Why do I need to re-link it?**
|
||||
|
||||
A: The new Docker Hub uses a different permissions model. [Linking is only a few clicks by going to account settings](link-source.md).
|
||||
with the new Docker Hub.
|
||||
|
||||
> **Note**: If you are linking a source code provider to create autobuilds for a team, follow the instructions to [create a service account](/docker-hub/builds.md#service-users-for-team-autobuilds) for the team before linking the account as described below.
|
||||
|
||||
**Q: What happens to automated builds I created in the old Docker Hub?**
|
||||
|
||||
A: They are now Classic Automated Builds. There are no functional differences with the old automated builds and everything
|
||||
(build triggers, existing build rules) should continue to work seamlessly.
|
||||
|
||||
**Q: Is it possible to convert an existing Classic Automated Build?**
|
||||
|
||||
A: This is currently unsupported. However, we are working to transition all builds into new experience in
|
||||
the coming months.
|
After Width: | Height: | Size: 131 KiB |
Before Width: | Height: | Size: 188 KiB After Width: | Height: | Size: 60 KiB |
Before Width: | Height: | Size: 254 KiB After Width: | Height: | Size: 106 KiB |
Before Width: | Height: | Size: 313 KiB After Width: | Height: | Size: 152 KiB |
After Width: | Height: | Size: 176 KiB |
Before Width: | Height: | Size: 60 KiB After Width: | Height: | Size: 48 KiB |
|
@ -1,12 +1,13 @@
|
|||
---
|
||||
description: Set up Automated builds
|
||||
keywords: automated, build, images
|
||||
description: Set up automated builds
|
||||
keywords: automated, build, images, Docker Hub
|
||||
redirect_from:
|
||||
- /docker-hub/builds/automated-build/
|
||||
- /docker-cloud/feature-reference/automated-build/
|
||||
- /docker-cloud/builds/automated-build/
|
||||
- /docker-cloud/builds/
|
||||
title: Set up Automated builds
|
||||
- /docker-hub/builds/classic/
|
||||
title: Set up automated builds
|
||||
---
|
||||
|
||||
|
||||
|
@ -268,22 +269,9 @@ You can specify a regular expression (regex) so that only matching branches or
|
|||
tags are built. You can also use the results of the regex to create the Docker
|
||||
tag that is applied to the built image.
|
||||
|
||||
You can use the variable `{sourceref}` to use the branch or tag name that
|
||||
matched the regex in the Docker tag applied to the resulting built image. (The
|
||||
variable includes the whole source name, not just the portion that matched the
|
||||
regex.) You can also use up to nine regular expression capture groups
|
||||
You can use up to nine regular expression capture groups
|
||||
(expressions enclosed in parentheses) to select a source to build, and reference
|
||||
these in the Docker Tag field using `{\1}` through `{\9}`.
|
||||
|
||||
**Regex example: build from version number branch and tag with version number**
|
||||
|
||||
You might want to automatically build any branches that end with a number
|
||||
formatted like a version number, and tag their resulting Docker images using a
|
||||
name that incorporates that branch name.
|
||||
|
||||
To do this, specify a `branch` build with the regex `/[0-9.]+$/` in the
|
||||
**Source** field, and use the formula `version-{sourceref}` in the **Docker
|
||||
tag** field.
|
||||
these in the **Docker Tag** field using `{\1}` through `{\9}`.
|
||||
|
||||
<!-- Capture groups Not a priority
|
||||
#### Regex example: build from version number branch and tag with version number
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
description: Link to GitHub and BitBucket
|
||||
keywords: Docker, docker, registry, accounts, plans, Dockerfile, Docker Hub, docs, documentation, trusted, builds, trusted builds, automated builds, GitHub
|
||||
title: Configure Automated Builds from GitHub and BitBucket
|
||||
keywords: Docker, docker, registry, accounts, plans, Dockerfile, Docker Hub, trusted, builds, trusted builds, automated builds, GitHub
|
||||
title: Configure automated builds from GitHub and BitBucket
|
||||
redirect_from:
|
||||
- /docker-hub/github/
|
||||
- /docker-hub/bitbucket/
|
||||
|
@ -18,60 +18,57 @@ organizations.
|
|||
|
||||
## Link to a GitHub user account
|
||||
|
||||
1. Click **Settings** in the top-right dropdown navigation.
|
||||
1. Log in to Docker Hub using your Docker ID.
|
||||
|
||||
2. Click or scroll down to **Linked Accounts**.
|
||||
2. Click **Account Settings** in the top-right dropdown navigation, then open **Linked Accounts**.
|
||||
|
||||
3. Click the plug icon for the source provider you want to link.
|
||||
3. Click **Connect** for the source provider you want to link.
|
||||
|
||||

|
||||

|
||||
|
||||
4. Review the settings for the **Docker Hub Builder** OAuth application.
|
||||

|
||||
|
||||

|
||||
|
||||
>**Note**: If you are the owner of any GitHub organizations, you might see
|
||||
options to grant Docker Hub access to them from this screen. You can also
|
||||
individually edit an organization's Third-party access settings to grant or
|
||||
individually edit an organization's third-party access settings to grant or
|
||||
revoke Docker Hub's access. See [Grant access to a GitHub
|
||||
organization](link-source.md#grant-access-to-a-github-organization) to learn more.
|
||||
organization](link-source.md#grant-access-to-a-github-organization) to
|
||||
learn more.
|
||||
|
||||
5. Click **Authorize application** to save the link.
|
||||
5. Click **Authorize docker** to save the link.
|
||||
|
||||
## Link to a Bitbucket user account
|
||||
|
||||
1. Log in to Docker Hub using your Docker ID.
|
||||
|
||||
2. Click **Settings** in the top-right dropdown navigation.
|
||||
2. Click **Account Settings** in the top-right dropdown navigation, then open
|
||||
the **Linked Accounts** section.
|
||||
|
||||
3. Scroll to the **Linked Accounts** section.
|
||||
3. Click **Connect** for the source provider you want to link.
|
||||
|
||||
4. Click the plug icon for the source provider you want to link.
|
||||

|
||||
|
||||

|
||||
4. If necessary, log in to Bitbucket.
|
||||
|
||||
5. If necessary, log in to Bitbucket.
|
||||
|
||||
6. On the page that appears, click **Grant access**.
|
||||
5. On the page that appears, click **Grant access**.
|
||||
|
||||
### Unlink a GitHub user account
|
||||
|
||||
To revoke Docker Hub's access to your GitHub account, you must unlink it both
|
||||
from Docker Hub, *and* from your GitHub account.
|
||||
|
||||
1. Click **Settings** in the top-right dropdown navigation, and click or scroll to the
|
||||
**Linked Accounts** section.
|
||||
1. Click **Account Settings** in the top-right dropdown navigation, then open
|
||||
the **Linked Accounts** section.
|
||||
|
||||
2. Click the plug icon next to the source provider you want to remove.
|
||||
|
||||
The icon turns gray and has a slash through it when the account is disabled
|
||||
but not revoked. You can use this to _temporarily_ disable a linked source
|
||||
code provider account.
|
||||
3. Go to your GitHub account's **Settings** page.
|
||||
|
||||
4. Go to your GitHub account's **Settings** page.
|
||||
4. Click **Applications** in the left navigation bar.
|
||||
|
||||
5. Click **OAuth applications** in the left navigation bar.
|
||||
|
||||
6. Click **Revoke** next to the Docker Hub Builder application.
|
||||
5. Click the `...` menu to the right of the Docker Hub Builder application and select **Revoke**.
|
||||
|
||||
> **Note**: Each repository that is configured as an automated build source
|
||||
contains a webhook that notifies Docker Hub of changes in the repository.
|
||||
|
@ -109,6 +106,7 @@ section at the lower left.
|
|||
5. Click the pencil icon next to Docker Hub Builder.
|
||||
|
||||
6. Click **Grant access** next to the organization.
|
||||
|
||||

|
||||
|
||||
|
||||
|
@ -117,10 +115,14 @@ section at the lower left.
|
|||
To revoke Docker Hub's access to an organization's GitHub repositories:
|
||||
|
||||
1. From your GitHub Account settings, locate the **Organization settings** section at the lower left.
|
||||
|
||||
2. Click the organization you want to revoke Docker Hub's access to.
|
||||
|
||||
3. From the Organization Profile menu, click **Third-party access**.
|
||||
The page displays a list of third party applications and their access status.
|
||||
|
||||
4. Click the pencil icon next to Docker Hub Builder.
|
||||
|
||||
5. On the next page, click **Deny access**.
|
||||
|
||||
|
||||
|
@ -129,13 +131,12 @@ To revoke Docker Hub's access to an organization's GitHub repositories:
|
|||
To permanently revoke Docker Hub's access to your Bitbucket account, you must
|
||||
unlink it both from Docker Hub, *and* from your Bitbucket account.
|
||||
|
||||
1. Find **Settings** in the top-right dropdown navigation, and scroll to **Linked Accounts**
|
||||
1. Log in to Docker Hub using your Docker ID.
|
||||
|
||||
2. Click the plug icon next to the source provider you want to remove.
|
||||
2. Click **Account Settings** in the top-right dropdown navigation, then open
|
||||
the **Linked Accounts** section.
|
||||
|
||||
The icon turns gray and has a slash through it when the account is disabled,
|
||||
however access may not have been revoked. You can use this to _temporarily_
|
||||
disable a linked source code provider account.
|
||||
3. Click the plug icon next to the source provider you want to remove.
|
||||
|
||||
4. Go to your Bitbucket account and click the user menu icon in the top-right corner.
|
||||
|
||||
|
|