Merge pull request #3 from docker/DESKTOP-2410-action-definition

DESKTOP-2410 action definition

Author: zappy-shu

.github/workflows/main.yml

@@ -1,5 +1,13 @@
 name: CI
-on: [push, pull_request]
+
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - '*'
+  pull_request:
+
 jobs:
   build:
     name: build
@@ -9,14 +17,17 @@ jobs:
     - name: Checkout
       uses: actions/checkout@v2
 
-    - name: Print env
-      run: env
-
-    - name: Read event json
-      run: cat $GITHUB_EVENT_PATH
-
-    - name: Build
-      run: DOCKER_BUILDKIT=1 make -f docker.Makefile build
+    - name: build and test code
+      run: DOCKER_BUILDKIT=1 make -f docker.Makefile all
 
-    - name: E2E
-      run: DOCKER_BUILDKIT=1 make -f docker.Makefile test-e2e
+    - name: build and push image
+      uses: ./
+      env:
+        DOCKER_BUILDKIT: 1
+      with:
+        username: ${{ secrets.DOCKER_USERNAME }}
+        password: ${{ secrets.DOCKER_PASSWORD }}
+        repository: docker/github-actions
+        tag_with_ref: true
+        build_args: MAKE_TARGET=build
+        push: ${{ startsWith(github.ref, 'refs/tags/') }}

README.md

@@ -88,7 +88,7 @@ Auto tags depend on the git reference that the run is associated with. The refer
 
 If the reference is `refs/heads/{branch-name}` then the tag `{branch-name}` is added. For the master branch the `{branch-name}` is replaced with `latest`.
 
-If the reference is `refs/pull-requests/{pr}` then the tag `pr-{pr}` is added.
+If the reference is `refs/pull/{pr}` then the tag `pr-{pr}` is added.
 
 If the reference is `refs/tags/{tag-name}` then the tag `{tag-name}` is added.
 

action.yml

@@ -0,0 +1,60 @@
+name: Build and push docker images
+description: Builds and pushes docker images and will log in to a docker registry if required
+author: Docker
+runs:
+  using: docker
+  image: docker://docker/github-actions:v0.0.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
+    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 server/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 run docker build from
+    required: false
+    default: "."
+  dockerfile:
+    description: Name of the Dockerfile (Default is 'path/Dockerfile')
+    required: false
+  target:
+    description: Sets the target build 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-delmited list of build-time variables
+    required: false
+  labels:
+    description: Comma-delimited list of labels to add to the built image. E.g. `label_name_1=label_value_1,label_name_2=label_value_2`
+    required: false
+  add_git_labels:
+    description: Adds labels with git repo info to the built image
+    required: false
+    default: false
+  push:
+    description: Whether to push the image
+    required: false
+    default: true

cmd/build_push.go

@@ -1,6 +1,8 @@
 package main
 
 import (
+	"fmt"
+
 	"github.com/docker/github-actions/internal/command"
 	"github.com/docker/github-actions/internal/options"
 )
@@ -37,7 +39,10 @@ func buildPush(cmd command.Runner) error {
 				return err
 			}
 		}
+
+		return command.RunPush(cmd, tags)
 	}
 
-	return command.RunPush(cmd, tags)
+	fmt.Println("Skipping push")
+	return nil
 }

cmd/main.go

@@ -5,17 +5,10 @@ import (
 	"os"
 
 	"github.com/docker/github-actions/internal/command"
-	"github.com/docker/github-actions/internal/options"
 	"github.com/spf13/cobra"
 )
 
 func main() {
-	_, err := options.GetGitHubOptions()
-	if err != nil {
-		fmt.Println(err)
-		os.Exit(1)
-	}
-
 	runner := command.NewRunner()
 
 	rootCmd := &cobra.Command{
@@ -53,7 +46,7 @@ func main() {
 		},
 	)
 
-	if err = rootCmd.Execute(); err != nil {
+	if err := rootCmd.Execute(); err != nil {
 		fmt.Println(err)
 		os.Exit(1)
 	}

docker.Makefile

@@ -4,7 +4,7 @@ DOCKER_BUILD = docker build --progress=plain
 ROOT_DIR = $(dir $(realpath $(firstword $(MAKEFILE_LIST))))
 ROOT_DIR := $(subst .\,,$(ROOT_DIR))
 
-all: build test-unit
+all: build test-e2e
 
 build:
 	$(DOCKER_BUILD) -t docker/github-actions-default --build-arg MAKE_TARGET=default .

e2e/testdata/build_tests/tag_pr.env

@@ -4,4 +4,4 @@ INPUT_TAG_WITH_REF=true
 INPUT_ADD_GIT_LABELS=false
 INPUT_REGISTRY=localhost:5000
 INPUT_REPOSITORY=my-repository
-GITHUB_REF=refs/pulls/pr1
+GITHUB_REF=refs/pull/pr1

internal/command/args.go

@@ -15,7 +15,7 @@ func LoginArgs(o options.Login, registry string) []string {
 
 // BuildArgs converts build options into the cli arguments used to call `docker build`
 func BuildArgs(o options.Build, github options.GitHub, tags []string) []string {
-	args := []string{"build"}
+	args := []string{"build", "--progress", "plain"}
 
 	for _, tag := range tags {
 		args = append(args, "-t", tag)

internal/command/args_test.go

@@ -33,26 +33,26 @@ func TestBuildArgs(t *testing.T) {
 		{
 			name:     "basic",
 			build:    options.Build{Path: "path"},
-			expected: []string{"build", "path"},
+			expected: []string{"build", "--progress", "plain", "path"},
 		},
 		{
 			name:     "with-dockerfile",
 			build:    options.Build{Path: ".", Dockerfile: "dockerfile"},
-			expected: []string{"build", "--file", "dockerfile", "."},
+			expected: []string{"build", "--progress", "plain", "--file", "dockerfile", "."},
 		},
 		{
 			name:     "with-tags",
 			build:    options.Build{Path: "."},
 			tags:     []string{"tag1", "tag2"},
-			expected: []string{"build", "-t", "tag1", "-t", "tag2", "."},
+			expected: []string{"build", "--progress", "plain", "-t", "tag1", "-t", "tag2", "."},
 		},
 		{
 			name: "with-static-labels",
 			build: options.Build{
 				Path:   ".",
 				Labels: []string{"label1", "label2"},
 			},
-			expected: []string{"build", "--label", "label1", "--label", "label2", "."},
+			expected: []string{"build", "--progress", "plain", "--label", "label1", "--label", "label2", "."},
 		},
 		{
 			name: "with-git-labels",
@@ -65,31 +65,31 @@ func TestBuildArgs(t *testing.T) {
 				Actor: "actor",
 				Sha:   "sha",
 			},
-			expected: []string{"build", "--label", "label1", "--label", "com.docker.github-actions-actor=actor", "--label", "com.docker.github-actions-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{
 				Path:   ".",
 				Target: "target",
 			},
-			expected: []string{"build", "--target", "target", "."},
+			expected: []string{"build", "--progress", "plain", "--target", "target", "."},
 		},
 		{
 			name: "with-always-pull",
 			build: options.Build{
 				Path:       ".",
 				AlwaysPull: true,
 			},
-			expected: []string{"build", "--pull", "."},
+			expected: []string{"build", "--progress", "plain", "--pull", "."},
 		},
 		{
 			name: "with-build-args",
 			build: options.Build{
 				Path:      ".",
 				BuildArgs: []string{"build-arg-1", "build-arg-2"},
 			},
-			expected: []string{"build", "--build-arg", "build-arg-1", "--build-arg", "build-arg-2", "."},
+			expected: []string{"build", "--progress", "plain", "--build-arg", "build-arg-1", "--build-arg", "build-arg-2", "."},
 		},
 	}
 	for _, tc := range testCases {

internal/command/runner.go

@@ -1,6 +1,7 @@
 package command
 
 import (
+	"fmt"
 	"os"
 	"os/exec"
 
@@ -30,18 +31,21 @@ func (runner execRunner) Run(name string, args ...string) error {
 
 // RunLogin runs a docker login
 func RunLogin(cmd Runner, opt options.Login, registry string) error {
+	fmt.Println("Logging in to registry", registry)
 	args := LoginArgs(opt, registry)
 	return cmd.Run("docker", args...)
 }
 
 // RunBuild runs a docker build and tags the resulting image
 func RunBuild(cmd Runner, opt options.Build, github options.GitHub, tags []string) error {
+	fmt.Println("Building image", tags)
 	args := BuildArgs(opt, github, tags)
 	return cmd.Run("docker", args...)
 }
 
 // RunPush runs a docker push for each tag
 func RunPush(cmd Runner, tags []string) error {
+	fmt.Println("Pushing image", tags)
 	for _, tag := range tags {
 		args := PushArgs(tag)
 		if err := cmd.Run("docker", args...); err != nil {