From 646552f0a10fc45d23fb5d14bdae567ea53969e3 Mon Sep 17 00:00:00 2001 From: CrazyMax Date: Sat, 3 Apr 2021 20:41:31 +0200 Subject: [PATCH] Fix doc links Signed-off-by: CrazyMax --- README.md | 23 +++++++++-------------- UPGRADE.md | 12 ++++++------ docs/advanced/cache.md | 2 +- docs/advanced/push-multi-registries.md | 2 +- docs/advanced/tags-labels.md | 4 ++-- 5 files changed, 19 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index e66021a..6601b8c 100644 --- a/README.md +++ b/README.md @@ -19,11 +19,6 @@ GitHub Action to build and push Docker images with [Buildx](https://github.com/d features provided by [Moby BuildKit](https://github.com/moby/buildkit) builder toolkit. This includes multi-platform build, secrets, remote cache, etc. and different builder deployment/namespacing options. -> :bulb: See also: -> * [login](https://github.com/docker/login-action) action -> * [setup-buildx](https://github.com/docker/setup-buildx-action) action -> * [setup-qemu](https://github.com/docker/setup-qemu-action) action - ![Screenshot](.github/build-push-action.png) ___ @@ -65,8 +60,8 @@ this restriction. In the examples below we are using 3 other actions: * [`setup-buildx`](https://github.com/docker/setup-buildx-action) action will create and boot a builder using by -default the `docker-container` [builder driver](https://github.com/docker/buildx#--driver-driver). This is -**not required but recommended** using it to be able to build multi-platform images, export cache, etc. +default the `docker-container` [builder driver](https://github.com/docker/buildx/blob/master/docs/reference/buildx_create.md#driver). +This is **not required but recommended** using it to be able to build multi-platform images, export cache, etc. * [`setup-qemu`](https://github.com/docker/setup-qemu-action) action can be useful if you want to add emulation support with QEMU to be able to build against more platforms. * [`login`](https://github.com/docker/login-action) action will take care to log in against a Docker registry. @@ -208,14 +203,14 @@ Following inputs can be used as `step.with` keys | `tags` | List/CSV | List of tags | | `pull` | Bool | Always attempt to pull a newer version of the image (default `false`) | | `target` | String | Sets the target stage to build | -| `allow` | List/CSV | List of [extra privileged entitlement](https://github.com/docker/buildx#--allowentitlement) (eg. `network.host,security.insecure`) | +| `allow` | List/CSV | List of [extra privileged entitlement](https://github.com/docker/buildx/blob/master/docs/reference/buildx_build.md#allow) (eg. `network.host,security.insecure`) | | `no-cache` | Bool | Do not use cache when building the image (default `false`) | -| `platforms` | List/CSV | List of [target platforms](https://github.com/docker/buildx#---platformvaluevalue) for build | -| `load` | Bool | [Load](https://github.com/docker/buildx#--load) is a shorthand for `--output=type=docker` (default `false`) | -| `push` | Bool | [Push](https://github.com/docker/buildx#--push) is a shorthand for `--output=type=registry` (default `false`) | -| `outputs` | List | List of [output destinations](https://github.com/docker/buildx#-o---outputpath-typetypekeyvalue) (format: `type=local,dest=path`) | -| `cache-from` | List | List of [external cache sources](https://github.com/docker/buildx#--cache-fromnametypetypekeyvalue) (eg. `type=local,src=path/to/dir`) | -| `cache-to` | List | List of [cache export destinations](https://github.com/docker/buildx#--cache-tonametypetypekeyvalue) (eg. `type=local,dest=path/to/dir`) | +| `platforms` | List/CSV | List of [target platforms](https://github.com/docker/buildx/blob/master/docs/reference/buildx_build.md#platform) for build | +| `load` | Bool | [Load](https://github.com/docker/buildx/blob/master/docs/reference/buildx_build.md#load) is a shorthand for `--output=type=docker` (default `false`) | +| `push` | Bool | [Push](https://github.com/docker/buildx/blob/master/docs/reference/buildx_build.md#push) is a shorthand for `--output=type=registry` (default `false`) | +| `outputs` | List | List of [output destinations](https://github.com/docker/buildx/blob/master/docs/reference/buildx_build.md#output) (format: `type=local,dest=path`) | +| `cache-from` | List | List of [external cache sources](https://github.com/docker/buildx/blob/master/docs/reference/buildx_build.md#cache-from) (eg. `type=local,src=path/to/dir`) | +| `cache-to` | List | List of [cache export destinations](https://github.com/docker/buildx/blob/master/docs/reference/buildx_build.md#cache-to) (eg. `type=local,dest=path/to/dir`) | | `secrets` | List | List of secrets to expose to the build (eg. `key=string`, `GIT_AUTH_TOKEN=mytoken`) | | `secret-files` | List | List of secret files to expose to the build (eg. `key=filename`, `MY_SECRET=./secret.txt`) | | `ssh` | List | List of SSH agent socket or keys to expose to the build | diff --git a/UPGRADE.md b/UPGRADE.md index 82c2f25..5864de7 100644 --- a/UPGRADE.md +++ b/UPGRADE.md @@ -7,12 +7,12 @@ * Rename `dockerfile` input to `file` for consistency with other Docker build tools * Rename `always_pull` input to `pull` for consistency with other Docker build tools * Add `builder` input to be able to choose a builder instance through our [setup-buildx action](https://github.com/docker/setup-buildx-action) -* Add [`platforms`](https://github.com/docker/buildx#---platformvaluevalue) input to support multi-platform builds -* Add [`allow`](https://github.com/docker/buildx#--allowentitlement) input -* Add [`load`](https://github.com/docker/buildx#--load) input -* Add [`outputs`](https://github.com/docker/buildx#-o---outputpath-typetypekeyvalue) input -* Add [`cache-from`](https://github.com/docker/buildx#--cache-fromnametypetypekeyvalue) input (`cache_froms` removed) -* Add [`cache-to`](https://github.com/docker/buildx#--cache-tonametypetypekeyvalue) input +* Add `platforms` input to support multi-platform builds +* Add `allow` input +* Add `load` input +* Add `outputs` input +* Add `cache-from` input (`cache_froms` removed) +* Add `cache-to` input * Rename `build_args` input to `build-args` for consistency with other Docker build tools * Add `secrets` input * Review `tags` input diff --git a/docs/advanced/cache.md b/docs/advanced/cache.md index 402831e..0c0592d 100644 --- a/docs/advanced/cache.md +++ b/docs/advanced/cache.md @@ -3,7 +3,7 @@ * [Registry cache](#registry-cache) * [GitHub cache](#github-cache) -> More info about buildx cache: https://github.com/docker/buildx#--cache-fromnametypetypekeyvalue +> More info about buildx cache: https://github.com/docker/buildx/blob/master/docs/reference/buildx_build.md#cache-from ## Registry cache diff --git a/docs/advanced/push-multi-registries.md b/docs/advanced/push-multi-registries.md index f10984d..e4dd8ab 100644 --- a/docs/advanced/push-multi-registries.md +++ b/docs/advanced/push-multi-registries.md @@ -41,7 +41,7 @@ jobs: with: registry: ghcr.io username: ${{ github.repository_owner }} - password: ${{ secrets.CR_PAT }} + password: ${{ secrets.GITHUB_TOKEN }} - name: Build and push uses: docker/build-push-action@v2 diff --git a/docs/advanced/tags-labels.md b/docs/advanced/tags-labels.md index d6f17a7..21c3ccf 100644 --- a/docs/advanced/tags-labels.md +++ b/docs/advanced/tags-labels.md @@ -64,8 +64,8 @@ jobs: uses: docker/login-action@v1 with: registry: ghcr.io - username: ${{ secrets.GHCR_USERNAME }} - password: ${{ secrets.GHCR_TOKEN }} + username: ${{ github.repository_owner }} + password: ${{ secrets.GITHUB_TOKEN }} - name: Build and push uses: docker/build-push-action@v2