mirror of
https://github.com/docker/build-push-action.git
synced 2024-11-15 14:43:51 +08:00
120f6587bc
Clarify the documentation for the dockerfile and path action inputs including how they relate to each other. Signed-off-by: Nick Adcock <nick.adcock@docker.com>
64 lines
2.0 KiB
YAML
64 lines
2.0 KiB
YAML
name: Build and push Docker images
|
|
description: Builds and pushes Docker images and will log in to a Docker registry if required
|
|
author: Docker
|
|
branding:
|
|
icon: 'anchor'
|
|
color: 'blue'
|
|
runs:
|
|
using: docker
|
|
image: docker://docker/github-actions:v1.0
|
|
args:
|
|
- build-push
|
|
inputs:
|
|
username:
|
|
description: Username used to log in to a Docker registry. If not set then no login will occur
|
|
required: false
|
|
password:
|
|
description: Password or personal access token used to log in to a Docker registry. If not set then no login will occur
|
|
required: false
|
|
registry:
|
|
description: Server address of Docker registry. If not set then will default to Docker Hub
|
|
required: false
|
|
repository:
|
|
description: Docker repository to tag the image with
|
|
required: true
|
|
tags:
|
|
description: Comma-delimited list of tags. These will be added to the registry/repository to form the image's tags
|
|
required: false
|
|
tag_with_ref:
|
|
description: Automatically tags the built image with the git reference as per the readme
|
|
required: false
|
|
default: false
|
|
tag_with_sha:
|
|
description: Automatically tags the built image with the git short SHA as per the readme
|
|
required: false
|
|
default: false
|
|
path:
|
|
description: Path to the build context
|
|
required: false
|
|
default: "."
|
|
dockerfile:
|
|
description: Path to the Dockerfile (Default is '{path}/Dockerfile')
|
|
required: false
|
|
target:
|
|
description: Sets the target stage to build
|
|
required: false
|
|
always_pull:
|
|
description: Always attempt to pull a newer version of the image
|
|
required: false
|
|
default: false
|
|
build_args:
|
|
description: Comma-delimited list of build-time variables
|
|
required: false
|
|
labels:
|
|
description: Comma-delimited list of labels to add to the built image
|
|
required: false
|
|
add_git_labels:
|
|
description: Adds labels with git repository information to the built image
|
|
required: false
|
|
default: false
|
|
push:
|
|
description: Whether to push the image
|
|
required: false
|
|
default: true
|