Merge pull request #5 from docker/add-opencontainers-labels

add_git_labels adds opencontainers labels

Author: zappy-shu

README.md

@@ -38,12 +38,15 @@ See the tagging section for information on tag inputs
 
 ##### Git labels
 
-When `INPUT_ADD_GIT_LABELS` is `true` labels are automatically added to the image that contain data about the current state of the git repo:
+When `INPUT_ADD_GIT_LABELS` is `true` labels are automatically added to the image that contain data about the current state of the git repo based on the standards set out in https://github.com/opencontainers/image-spec/blob/master/annotations.md.
+
+3 labels are supported:
 
 |Label|Description|
 |---|---|
-|com.docker.github-actions-actor|The username of the user that kicked off this run of the actions (e.g. the user that did the git push)|
-|com.docker.github-actions-sha|The full git sha of this commit|
+|org.opencontainers.image.created|Date and time on which the image was built (string, date-time as defined by RFC 3339).|
+|org.opencontainers.image.source|URL to this repository. E.g. `https://github.com/myorg/myrepository`|
+|org.opencontainers.image.revision|The full git sha of this commit.|
 
 ### push
 

e2e/build_push_test.go

@@ -14,9 +14,7 @@ func TestBuildPush(t *testing.T) {
 		"localhost:5000/my-repository:build-push-test",
 	}
 	labels := map[string]string{
-		"a":                               "a1",
-		"com.docker.github-actions-actor": "actor",
-		"com.docker.github-actions-sha":   "sha",
+		"a": "a1",
 	}
 	err := removeImages(tags)
 	assert.NilError(t, err)

e2e/build_test.go

@@ -3,6 +3,7 @@ package e2e
 import (
 	"os/exec"
 	"testing"
+	"time"
 
 	"github.com/hashicorp/go-multierror"
 	"gotest.tools/v3/assert"
@@ -34,18 +35,6 @@ func TestBuild(t *testing.T) {
 				"b": "b1",
 			},
 		},
-		{
-			name:    "auto-labels",
-			envFile: "testdata/build_tests/auto_labels.env",
-			expectedTags: []string{
-				"localhost:5000/my-repository:auto-labels",
-			},
-			expectedLabels: map[string]string{
-				"a":                               "a1",
-				"com.docker.github-actions-actor": "actor",
-				"com.docker.github-actions-sha":   "sha",
-			},
-		},
 		{
 			name:    "auto-tags-master",
 			envFile: "testdata/build_tests/tag_master.env",
@@ -95,6 +84,26 @@ func TestBuild(t *testing.T) {
 	}
 }
 
+func TestBuildWithGitLabels(t *testing.T) {
+	tags := []string{"localhost:5000/my-repository:auto-labels"}
+	err := runActionsCommand("build", "testdata/build_tests/auto_labels.env")
+	assert.NilError(t, err)
+	defer removeImages(tags)
+
+	inspect, err := inspectImage(tags[0])
+	assert.NilError(t, err)
+	assert.DeepEqual(t, tags, inspect.RepoTags)
+
+	assert.Equal(t, 4, len(inspect.Config.Labels))
+	assert.Equal(t, "a1", inspect.Config.Labels["a"])
+	assert.Equal(t, "https://github.com/git/repository", inspect.Config.Labels["org.opencontainers.image.source"])
+	assert.Equal(t, "sha", inspect.Config.Labels["org.opencontainers.image.revision"])
+
+	created, err := time.Parse(time.RFC3339, inspect.Config.Labels["org.opencontainers.image.created"])
+	assert.NilError(t, err)
+	assert.Assert(t, created.Before(time.Now()))
+}
+
 func removeImages(tags []string) error {
 	var result error
 	for _, tag := range tags {

e2e/testdata/build_push_tests/build_push.env

@@ -1,14 +1,11 @@
 INPUT_PATH=./testdata/build_push_tests
 INPUT_DOCKERFILE=./testdata/build_push_tests/Dockerfile
 INPUT_TAG_WITH_REF=true
-INPUT_ADD_GIT_LABELS=true
 INPUT_TAGS=build-push-test
 INPUT_LABELS=a=a1
 INPUT_REGISTRY=localhost:5000
 INPUT_USERNAME=my_user
 INPUT_PASSWORD=my_password
 INPUT_REPOSITORY=my-repository
 INPUT_PUSH=true
-GITHUB_ACTOR=actor
-GITHUB_SHA=sha
 GITHUB_REF=refs/tags/build-push-tag1

e2e/testdata/build_tests/auto_labels.env

@@ -6,5 +6,5 @@ INPUT_TAGS=auto-labels
 INPUT_LABELS=a=a1
 INPUT_REGISTRY=localhost:5000
 INPUT_REPOSITORY=my-repository
-GITHUB_ACTOR=actor
+GITHUB_REPOSITORY=git/repository
 GITHUB_SHA=sha

internal/command/args_test.go

@@ -26,7 +26,6 @@ func TestBuildArgs(t *testing.T) {
 	testCases := []struct {
 		name     string
 		build    options.Build
-		github   options.GitHub
 		tags     []string
 		expected []string
 	}{
@@ -54,19 +53,6 @@ func TestBuildArgs(t *testing.T) {
 			},
 			expected: []string{"build", "--progress", "plain", "--label", "label1", "--label", "label2", "."},
 		},
-		{
-			name: "with-git-labels",
-			build: options.Build{
-				Path:         ".",
-				AddGitLabels: true,
-				Labels:       []string{"label1"},
-			},
-			github: options.GitHub{
-				Actor: "actor",
-				Sha:   "sha",
-			},
-			expected: []string{"build", "--progress", "plain", "--label", "label1", "--label", "com.docker.github-actions-actor=actor", "--label", "com.docker.github-actions-sha=sha", "."},
-		},
 		{
 			name: "with-target",
 			build: options.Build{
@@ -95,7 +81,7 @@ func TestBuildArgs(t *testing.T) {
 	for _, tc := range testCases {
 		tc := tc
 		t.Run(tc.name, func(t *testing.T) {
-			args := BuildArgs(tc.build, tc.github, tc.tags)
+			args := BuildArgs(tc.build, options.GitHub{}, tc.tags)
 			assert.DeepEqual(t, tc.expected, args)
 		})
 	}

internal/options/build.go

@@ -1,14 +1,14 @@
 package options
 
 import (
-	"fmt"
 	"os"
 	"strings"
+	"time"
 
 	"github.com/caarlos0/env/v6"
 )
 
-const githubLabelPrefix = "com.docker.github-actions"
+const opencontainersLabelPrefix = "org.opencontainers.image"
 
 // Build contains the parsed build action environment variables
 type Build struct {
@@ -50,13 +50,17 @@ func GetLabels(build Build, github GitHub) []string {
 		return labels
 	}
 
-	if github.Actor != "" {
-		labels = append(labels, fmt.Sprintf("%s-actor=%s", githubLabelPrefix, github.Actor))
+	if github.Repository != "" {
+		labels = append(labels, opencontainersLabelPrefix+".source=https://github.com/"+github.Repository)
 	}
 
 	if github.Sha != "" {
-		labels = append(labels, fmt.Sprintf("%s-sha=%s", githubLabelPrefix, github.Sha))
+		labels = append(labels, opencontainersLabelPrefix+".revision="+github.Sha)
+
 	}
 
+	createdTime := time.Now().UTC().Format(time.RFC3339)
+	labels = append(labels, opencontainersLabelPrefix+".created="+createdTime)
+
 	return labels
 }

internal/options/build_test.go

@@ -2,7 +2,9 @@ package options
 
 import (
 	"os"
+	"strings"
 	"testing"
+	"time"
 
 	"gotest.tools/v3/assert"
 )
@@ -31,46 +33,31 @@ func TestGetBuildOptions(t *testing.T) {
 }
 
 func TestGetLabels(t *testing.T) {
-	testCases := []struct {
-		name         string
-		addGitLabels bool
-		labels       []string
-		github       GitHub
-		expected     []string
-	}{
-		{
-			name:     "no-git-labels",
-			labels:   []string{"label1", "label2"},
-			expected: []string{"label1", "label2"},
-		},
-		{
-			name:         "with-git-labels",
-			labels:       []string{"label1", "label2"},
-			addGitLabels: true,
-			github: GitHub{
-				Actor: "actor",
-				Sha:   "sha",
-			},
-			expected: []string{
-				"label1",
-				"label2",
-				"com.docker.github-actions-actor=actor",
-				"com.docker.github-actions-sha=sha",
-			},
-		},
-	}
+	expected := []string{"label1", "label2"}
+	labels := GetLabels(Build{Labels: expected}, GitHub{})
+	assert.DeepEqual(t, expected, labels)
+}
 
-	for _, tc := range testCases {
-		tc := tc
-		t.Run(tc.name, func(t *testing.T) {
-			labels := GetLabels(
-				Build{
-					AddGitLabels: tc.addGitLabels,
-					Labels:       tc.labels,
-				},
-				tc.github,
-			)
-			assert.DeepEqual(t, tc.expected, labels)
+func TestGetLabelsWithGit(t *testing.T) {
+	labels := GetLabels(
+		Build{
+			Labels:       []string{"label1", "label2"},
+			AddGitLabels: true,
+		},
+		GitHub{
+			Repository: "myrepository",
+			Sha:        "mysha",
 		})
-	}
+
+	assert.Equal(t, 5, len(labels))
+	assert.Equal(t, "label1", labels[0])
+	assert.Equal(t, "label2", labels[1])
+	assert.Equal(t, "org.opencontainers.image.source=https://github.com/myrepository", labels[2])
+	assert.Equal(t, "org.opencontainers.image.revision=mysha", labels[3])
+
+	timeLabel := strings.SplitN(labels[4], "=", 2)
+	assert.Equal(t, "org.opencontainers.image.created", timeLabel[0])
+	labelTime, err := time.Parse(time.RFC3339, timeLabel[1])
+	assert.NilError(t, err)
+	assert.Assert(t, time.Now().After(labelTime))
 }

internal/options/github.go

@@ -45,7 +45,6 @@ type GitHub struct {
 	RunInActions bool   `env:"GITHUB_ACTIONS"`
 	Workflow     string `env:"GITHUB_WORKFLOW"`
 	Action       string `env:"GITHUB_ACTION"`
-	Actor        string `env:"GITHUB_ACTOR"`
 	Repository   string `env:"GITHUB_REPOSITORY"`
 	EventName    string `env:"GITHUB_EVENT_NAME"`
 	Sha          string `env:"GITHUB_SHA"`

internal/options/github_test.go

@@ -11,7 +11,6 @@ func TestGetGitHubOptions(t *testing.T) {
 	_ = os.Setenv("GITHUB_ACTIONS", "true")
 	_ = os.Setenv("GITHUB_WORKFLOW", "workflow")
 	_ = os.Setenv("GITHUB_ACTION", "action")
-	_ = os.Setenv("GITHUB_ACTOR", "actor")
 	_ = os.Setenv("GITHUB_REPOSITORY", "repository")
 	_ = os.Setenv("GITHUB_EVENT_NAME", "event-name")
 	_ = os.Setenv("GITHUB_SHA", "sha")
@@ -23,7 +22,6 @@ func TestGetGitHubOptions(t *testing.T) {
 		RunInActions: true,
 		Workflow:     "workflow",
 		Action:       "action",
-		Actor:        "actor",
 		Repository:   "repository",
 		EventName:    "event-name",
 		Sha:          "sha",