diff --git a/docs/tests/use-cases/ci-cd-for-go-project/base.cue.fragment b/docs/tests/use-cases/ci-cd-for-go-project/base.cue.fragment new file mode 100644 index 00000000..1f722bb3 --- /dev/null +++ b/docs/tests/use-cases/ci-cd-for-go-project/base.cue.fragment @@ -0,0 +1,14 @@ +import ( + "dagger.io/dagger" + "universe.dagger.io/go" +) + +dagger.#Plan & { + actions: { + // Improve go base image with useful tool + // Enable cgo by installing build-base + _base: go.#Image & { + packages: "build-base": version: _ + } + } +} \ No newline at end of file diff --git a/docs/tests/use-cases/ci-cd-for-go-project/build.cue.fragment b/docs/tests/use-cases/ci-cd-for-go-project/build.cue.fragment new file mode 100644 index 00000000..7c69e1c5 --- /dev/null +++ b/docs/tests/use-cases/ci-cd-for-go-project/build.cue.fragment @@ -0,0 +1,4 @@ +// Build go project +build: go.#Build & { + source: _code +} diff --git a/docs/tests/use-cases/ci-cd-for-go-project/complete-ci-cd/dagger.cue b/docs/tests/use-cases/ci-cd-for-go-project/complete-ci-cd/dagger.cue new file mode 100644 index 00000000..64867b47 --- /dev/null +++ b/docs/tests/use-cases/ci-cd-for-go-project/complete-ci-cd/dagger.cue @@ -0,0 +1,78 @@ +package main + +import ( + "dagger.io/dagger" + "universe.dagger.io/go" + "universe.dagger.io/docker" + "universe.dagger.io/alpine" +) + +dagger.#Plan & { + client: { + filesystem: ".": read: { + contents: dagger.#FS + include: ["go.mod", "go.sum", "**/*.go"] + } + + env: DOCKER_PASSWORD: dagger.#Secret + } + + actions: { + // Alias to code + _code: client.filesystem.".".read.contents + + // Improve go base image with useful tool + // Enable cgo by installing build-base + _base: go.#Image & { + packages: { + "build-base": version: _ + bash: version: _ + } + } + + // Run go unit test + "unit-test": go.#Test & { + source: _code + package: "./..." + input: _base.output + } + + // Build go project + build: go.#Build & { + source: _code + } + + // Build docker image (depends on build) + image: { + _base: alpine.#Build & {} + + docker.#Build & { + steps: [ + docker.#Copy & { + input: _base.output + contents: build.output + dest: "/usr/bin" + }, + docker.#Set & { + config: cmd: [""] + }, + ] + } + } + + // Push image to remote registry (depends on image) + push: { + // Docker username + _dockerUsername: "" + + docker.#Push & { + "image": image.output + dest: "\(_dockerUsername)/" + auth: { + username: "\(_dockerUsername)" + secret: client.env.DOCKER_PASSWORD + } + } + } + } +} diff --git a/docs/tests/use-cases/ci-cd-for-go-project/image.cue.fragment b/docs/tests/use-cases/ci-cd-for-go-project/image.cue.fragment new file mode 100644 index 00000000..b554eef3 --- /dev/null +++ b/docs/tests/use-cases/ci-cd-for-go-project/image.cue.fragment @@ -0,0 +1,22 @@ +import ( + "universe.dagger.io/alpine" + "universe.dagger.io/docker" +) + +// Build docker image (depends on build) +image: { + _base: alpine.#Build & {} + + docker.#Build & { + steps: [ + docker.#Copy & { + input: _base.output + contents: build.output + dest: "/usr/bin" + }, + docker.#Set & { + config: cmd: [""] + }, + ] + } +} \ No newline at end of file diff --git a/docs/tests/use-cases/ci-cd-for-go-project/push.cue.fragment b/docs/tests/use-cases/ci-cd-for-go-project/push.cue.fragment new file mode 100644 index 00000000..b742f0de --- /dev/null +++ b/docs/tests/use-cases/ci-cd-for-go-project/push.cue.fragment @@ -0,0 +1,14 @@ +// Push image to remote registry (depends on image) +push: { + // Docker username + _dockerUsername: "" + + docker.#Push & { + "image": image.output + dest: "\(_dockerUsername)/" + auth: { + username: "\(_dockerUsername)" + secret: client.env.DOCKER_PASSWORD + } + } +} \ No newline at end of file diff --git a/docs/tests/use-cases/ci-cd-for-go-project/retrieve-go-project/dagger.cue b/docs/tests/use-cases/ci-cd-for-go-project/retrieve-go-project/dagger.cue new file mode 100644 index 00000000..13483d79 --- /dev/null +++ b/docs/tests/use-cases/ci-cd-for-go-project/retrieve-go-project/dagger.cue @@ -0,0 +1,18 @@ +package main + +import ( + "dagger.io/dagger" +) + +dagger.#Plan & { + // Retrieve go source code + client: filesystem: ".": read: { + contents: dagger.#FS + include: ["go.mod", "go.sum", "**/*.go"] + } + + actions: { + // Alias to code directory + _code: client.filesystem.".".read.contents + } +} diff --git a/docs/tests/use-cases/ci-cd-for-go-project/test.cue.fragment b/docs/tests/use-cases/ci-cd-for-go-project/test.cue.fragment new file mode 100644 index 00000000..d1518765 --- /dev/null +++ b/docs/tests/use-cases/ci-cd-for-go-project/test.cue.fragment @@ -0,0 +1,6 @@ +// Run go unit test +"unit-test": go.#Test & { + source: _code + package: "./..." + input: _base.output +} diff --git a/docs/use-cases/1216-go-on-docker-hub.md b/docs/use-cases/1216-go-on-docker-hub.md new file mode 100644 index 00000000..44590cd2 --- /dev/null +++ b/docs/use-cases/1216-go-on-docker-hub.md @@ -0,0 +1,117 @@ +--- +slug: /1216/ci-cd-for-go-project +displayed_sidebar: europa +--- + +# Go on Docker Hub + +Dagger stand as a powerful CI/CD tool that works on any environment. + +For instance, you can use [go package](https://github.com/dagger/dagger/tree/main/pkg/universe.dagger.io/go) +to control the whole CI/CD process, from test to push into a remote registry. + +:::tip +Following examples can be used as a template for any standalone go project. +::: + +## Retrieve Go project + +First important step is to make go project accessible in dagger plan. + +You can indeed choose which files to include in the filesystem. +Since it's a Golang project, filesystem should contain module and every go +source files: + +```cue file=../tests/use-cases/ci-cd-for-go-project/retrieve-go-project/dagger.cue +``` + +:::tip +To make it more accessible in actions, you can set a private field that will +act as an alias. +::: + +## Build a Go base image + +[Dagger go universe](https://github.com/dagger/dagger/tree/main/pkg/universe.dagger.io/go) +provide a [base image](https://github.com/dagger/dagger/blob/main/pkg/universe.dagger.io/go/image.cue) +to build your pipeline but your project may use `CGO` or any external dependencies. + +You can customize that base image to install required dependencies: + +```cue file=../tests/use-cases/ci-cd-for-go-project/base.cue.fragment +``` + +## Run unit test + +Before deliver your application, you certainly want to run unit test. + +By using previous steps, you can use the [test](https://github.com/dagger/dagger/blob/main/pkg/universe.dagger.io/go/test.cue) +definition to run your unit test: + +```cue file=../tests/use-cases/ci-cd-for-go-project/test.cue.fragment +``` + + +:::tip +You can also use dagger to write integration tests +::: + +## Build Go binary + +To put your go project on docker hub, you first need to compile a binary. + +Go universe expose a [build](https://github.com/dagger/dagger/blob/main/pkg/universe.dagger.io/go/build.cue) +definition so you can build a binary: + +```cue file=../tests/use-cases/ci-cd-for-go-project/build.cue.fragment +``` + +:::tip +You can control the binary platform with `os` and `arch` field. +::: + +## Prepare docker image + +To make it usable by other user, you must put your binary in an image and set an entrypoint. + +For optimisation purpose, you can use alpine as base image to contain your binary: + +```cue file=../tests/use-cases/ci-cd-for-go-project/image.cue.fragment +``` + +## Push to Docker Hub + +To push an image to docker hub, you will need to forward credential to allow +dagger push. + +To not hard code your docker password in the plan, you can retrieve it as an +environment value: + +```cue +dagger.#Plan & { + client: { + // ... + + env: DOCKER_PASSWORD: dagger.#Secret + } +} +``` + +You can now push your image: + +```cue file=../tests/use-cases/ci-cd-for-go-project/push.cue.fragment +``` + +## Complete CI/CD + +After merging all examples, you will have a complete CI/CD to deliver a go +binary on Docker Hub. + +```cue file=../tests/use-cases/ci-cd-for-go-project/complete-ci-cd/dagger.cue +``` + +You can then use `dagger do` to select which action you want to run. + +## Push multi-platform + +Coming soon... diff --git a/website/sidebars.js b/website/sidebars.js index ca9aa8b6..eca05c90 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -102,6 +102,15 @@ module.exports = { "use-cases/go-docker-swarm", ], }, + { + type: "category", + label: "Use Cases", + collapsible: false, + collapsed: false, + items: [ + "use-cases/go-on-docker-hub" + ], + }, { type: "link", label: "⬅️ Dagger 0.1",