Merge pull request #26 from buildkite/update-golang-docker-example

Update Golang Docker Example (consistency sweep)

Author: 123sarahj123

.buildkite/pipeline.yml

@@ -1,5 +1,5 @@
 steps:
-  # group up all the steps that are related to the quality assurance of the code
+  # Group up all the steps that are related to the quality assurance of the code.
   - group: ':mag: QA'
     id: quality_assurance
     steps:
@@ -11,19 +11,19 @@ steps:
             run: app
     - key: test
       label: ':golang: test'
-      command: 
+      command:
         - go test -v -count=1 -cover ./... -coverprofile=coverage.txt -covermode=atomic
       artifact_paths:
-        - 'coverage.txt' # upload the coverage report as an artifact
+        - 'coverage.txt' # Upload the coverage report as an artifact.
       plugins:
         - docker-compose#v5.4.0:
             run: app
-  # build the application after the quality assurance steps are done
+  # Build the application after the quality assurance steps are done.
   - key: build
     label: ':golang: build'
     command: go build -o dist/app
     artifact_paths:
-      - 'dist/app' # upload the built application as an artifact
+      - 'dist/app' # Upload the built application as an artifact.
     plugins:
       - docker-compose#v5.4.0:
           run: app

.buildkite/template.yml

@@ -1,5 +1,10 @@
-# Used by the 'Add to Buildkite' button in the readme
 name: "Golang Docker Example"
+description: "An example pipeline that runs and tests a Go project inside Docker using Buildkite."
+emoji: ":golang:"
+color: "#EFF9FF"
+languages:
+  - "Go"
+  - "Docker"
 steps:
   - label: ":pipeline:"
-    command: "buildkite-agent pipeline upload"
+    command: "buildkite-agent pipeline upload"

Licence.md renamed to LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Buildkite Pty Ltd
+Copyright (c) 2025 Buildkite Pty Ltd
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -0,0 +1,45 @@
+# Buildkite Golang Docker Pipeline Example
+
+[![Build status](https://badge.buildkite.com/aab023f2f33ab06766ed6236bc40caf0df1d9448e4f590d0ee.svg?branch=main)](https://buildkite.com/buildkite/golang-docker-example/builds/latest?branch=main)
+[![Add to Buildkite](https://img.shields.io/badge/Add%20to%20Buildkite-14CC80)](https://buildkite.com/new)
+
+This repository is an example [Buildkite](https://buildkite.com/) pipeline that runs tests for a [Golang](https://go.dev) project inside [Docker](https://docker.com).
+
+👉 **See this example in action:** [buildkite/golang-docker-example](https://buildkite.com/buildkite/golang-docker-example/builds/latest?branch=main)
+
+[![Add to Buildkite](https://buildkite.com/button.svg)](https://buildkite.com/new)
+
+<a href="https://buildkite.com/buildkite/golang-docker-example/builds/latest?branch=main">
+  <img width="1491" alt="Screenshot of Buildkite Golang Docker example pipeline" src=".buildkite/screenshot.png" />
+</a>
+
+<!-- docs:start -->
+
+## How it works
+
+This example uses a Docker-based workflow to run Go tests:
+- The pipeline runs `go test` and `go vet` inside a container.
+- The container is defined using [`Dockerfile`](Dockerfile) and [`docker-compose.yml`](docker-compose.yml).
+- The Buildkite pipeline uploads steps using `pipeline.yml`.
+
+This is ideal if you want to containerize your builds or match production environments more closely.
+
+## Try it yourself
+
+To use this pattern in your own Go project:
+
+1. Make sure Docker and Docker Compose are installed. See: [Install Docker Compose](https://docs.docker.com/compose/install/)
+2. Copy the example config into your repo:
+
+```sh
+cd /your/golang/repo
+
+curl -O https://raw.githubusercontent.com/buildkite/golang-docker-example/main/Dockerfile
+curl -O https://raw.githubusercontent.com/buildkite/golang-docker-example/main/docker-compose.yml
+```
+
+<!-- docs:end -->
+
+## License
+
+See [LICENSE.md](LICENSE.md) (MIT)