Skip to content

Commit

Permalink
Merge pull request #2 from docker/opencontainers-labels
Browse files Browse the repository at this point in the history
Opencontainers labels
  • Loading branch information
Nick Adcock authored and GitHub committed Mar 9, 2020
2 parents ff1bd84 + 1ccd3cd commit df13b26
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Username used to log in to a Docker registry. If not set then no login will occu

### `password`

Password used to log in to a Docker registry. If not set then no login will occur.
Password or personal access token used to log in to a Docker registry. If not set then no login will occur.

### `registry`

Expand Down Expand Up @@ -102,7 +102,7 @@ Always attempt to pull a newer version of the image.

### `build_args`

Comma-delmited list of build-time variables.
Comma-delimited list of build-time variables.

Example:

Expand All @@ -124,14 +124,15 @@ labels: label_name_1=label_value_1,label_name_2=label_value_2

Boolean value. Defaults to `false`.

Adds labels with git repository information to the built image.
Adds labels with git repository information to the built image based on the standards set out in https://github.com/opencontainers/image-spec/blob/master/annotations.md.

The labels are:

|Label key|Example value|Description|
|---|---|---|
|`com.docker.github-actions-actor`|`my-username`|The actor that kicked off the workflow. For example this could be the username of the user that did the git push.|
|`com.docker.github-actions-sha`|`676cae2f85471aeff6776463c72881ebd902dcf9`|Full git SHA of the current commit.|
|`org.opencontainers.image.created`|`2020-03-06T23:00:00Z`|Date and time on which the image was built (string, date-time as defined by RFC 3339).|
|`org.opencontainers.image.source`|`https://github.com/myorg/myrepository`|URL to the GitHub repository.|
|`org.opencontainers.image.revision`|`676cae2f85471aeff6776463c72881ebd902dcf9`|The full git SHA of this commit.|


### `push`
Expand Down
10 changes: 5 additions & 5 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ description: Builds and pushes Docker images and will log in to a Docker registr
author: Docker
runs:
using: docker
image: docker://docker/github-actions:v0.0.1
image: docker://docker/github-actions:v0.1
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 used to log in to a Docker registry. If not set then no login will occur
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
Expand All @@ -27,7 +27,7 @@ inputs:
required: false
default: false
tag_with_sha:
description: Automatically tags the built image with the git short sha as per the readme
description: Automatically tags the built image with the git short SHA as per the readme
required: false
default: false
path:
Expand All @@ -45,13 +45,13 @@ inputs:
required: false
default: false
build_args:
description: Comma-delmited list of build-time variables
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 repo info to the built image
description: Adds labels with git repository information to the built image
required: false
default: false
push:
Expand Down

0 comments on commit df13b26

Please sign in to comment.