refactor: rename project to doco-cd (#61)

* refactor: rename project to doco-cd * docs: adjust docs
kimdre · Aug 5, 2024 · c1720e6 · c1720e6
1 parent 72f7500
commit c1720e6
Show file tree

Hide file tree

Showing 11 changed files with 34 additions and 27 deletions.
diff --git a/.gitmodules b/.gitmodules
@@ -1,3 +1,3 @@
 [submodule "docs"]
 	path = docs
-	url = git@github.com:kimdre/docker-compose-webhook.wiki.git
+	url = git@github.com:kimdre/doco-cd.wiki.git
diff --git a/Dockerfile b/Dockerfile
@@ -30,12 +30,12 @@ FROM gcr.io/distroless/base-debian12@sha256:1aae189e3baecbb4044c648d356ddb75025b
 
 WORKDIR /
 
-COPY --from=build-stage /docker-compose-webhook /docker-compose-webhook
+COPY --from=build-stage /doco-cd /doco-cd
 
 ENV TZ=UTC \
     HTTP_PORT=80 \
     LOG_LEVEL=info
 
 USER nonroot:nonroot
 
-CMD ["/docker-compose-webhook"]
+CMD ["/doco-cd"]
diff --git a/Makefile b/Makefile
@@ -1,5 +1,5 @@
 BINARY_DIR=bin
-BINARY_NAME=docker-compose-webhook
+BINARY_NAME=doco-cd
 .PHONY: test build run lint fmt update update-all submodule-commit generate-coverage
 
 test:

diff --git a/README.md b/README.md
@@ -1,16 +1,23 @@
-# docker-compose-webhook
+# doco-cd - Docker Compose Continuous Deployment
 
 ## GitOps for Docker Compose
 
-![GitHub Release](https://img.shields.io/github/v/release/kimdre/docker-compose-webhook?display_name=tag&label=Release)
-[![CodeQL](https://github.com/kimdre/docker-compose-webhook/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/kimdre/docker-compose-webhook/actions/workflows/github-code-scanning/codeql)
-[![Spell checking](https://github.com/kimdre/docker-compose-webhook/actions/workflows/spelling.yaml/badge.svg)](https://github.com/kimdre/docker-compose-webhook/actions/workflows/spelling.yaml)
-[![Build Image](https://github.com/kimdre/docker-compose-webhook/actions/workflows/build.yaml/badge.svg)](https://github.com/kimdre/docker-compose-webhook/actions/workflows/build.yaml)
+[![GitHub Release](https://img.shields.io/github/v/release/kimdre/doco-cd?display_name=tag&label=Release)](https://github.com/kimdre/doco-cd/releases)
+[![CodeQL](https://github.com/kimdre/doco-cd/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/kimdre/doco-cd/actions/workflows/github-code-scanning/codeql)
+[![Tests](https://github.com/kimdre/doco-cd/actions/workflows/test.yaml/badge.svg)](https://github.com/kimdre/doco-cd/actions/workflows/test.yaml)
+[![Spell checking](https://github.com/kimdre/doco-cd/actions/workflows/spelling.yaml/badge.svg)](https://github.com/kimdre/doco-cd/actions/workflows/spelling.yaml)
+[![Build Image](https://github.com/kimdre/doco-cd/actions/workflows/build.yaml/badge.svg)](https://github.com/kimdre/doco-cd/actions/workflows/build.yaml)
 
 
-Docker Compose Webhook is a lightweight GitOps tool that automatically deploys and updates Docker Compose services using webhooks, that are triggered by your Git repository.
-You can think of a ArgoCD alternative for Docker.
+Doco CD is a lightweight GitOps tool that automatically deploys and updates Docker Compose services using webhooks, that are triggered by your Git repository.
+You can think of it as a simple Portainer or ArgoCD alternative for Docker.
 
 ## Documentation
 
-You can find the documentation in the [Wiki](https://github.com/kimdre/docker-compose-webhook/wiki).
+You can find the documentation in the [Wiki](https://github.com/kimdre/doco-cd/wiki).
+
+## Community
+
+- Ask questions on [GitHub Discussions](https://github.com/kimdre/doco-cd/discussions)
+- Report bugs or suggest features by [opening an issue](https://github.com/kimdre/doco-cd/issues/new)
+- Contribute by [opening a pull request](https://github.com/kimdre/doco-cd/pulls)
diff --git a/cmd/docker-compose-webhook/main.go → cmd/doco-cd/main.go b/cmd/docker-compose-webhook/main.go → cmd/doco-cd/main.go
@@ -10,21 +10,21 @@ import (
 	"path"
 	"reflect"
 
-	"github.com/kimdre/docker-compose-webhook/internal/webhook"
+	"github.com/kimdre/doco-cd/internal/webhook"
 
 	"github.com/docker/cli/cli/command"
 
 	"github.com/google/uuid"
 
 	"github.com/compose-spec/compose-go/v2/cli"
 	"github.com/docker/docker/client"
-	"github.com/kimdre/docker-compose-webhook/internal/utils"
+	"github.com/kimdre/doco-cd/internal/utils"
 
-	"github.com/kimdre/docker-compose-webhook/internal/docker"
+	"github.com/kimdre/doco-cd/internal/docker"
 
-	"github.com/kimdre/docker-compose-webhook/internal/config"
-	"github.com/kimdre/docker-compose-webhook/internal/git"
-	"github.com/kimdre/docker-compose-webhook/internal/logger"
+	"github.com/kimdre/doco-cd/internal/config"
+	"github.com/kimdre/doco-cd/internal/git"
+	"github.com/kimdre/doco-cd/internal/logger"
 )
 
 const (

diff --git a/dev.compose.yaml b/dev.compose.yaml
@@ -1,6 +1,6 @@
 services:
   app:
-    container_name: docker-compose-webhook
+    container_name: doco-cd
     build: .
     restart: no
     ports:

diff --git a/docs b/docs
diff --git a/go.mod b/go.mod
@@ -1,4 +1,4 @@
-module github.com/kimdre/docker-compose-webhook
+module github.com/kimdre/doco-cd
 
 go 1.22.5
 

diff --git a/internal/docker/compose.go b/internal/docker/compose.go
@@ -15,7 +15,7 @@ import (
 	"syscall"
 	"time"
 
-	"github.com/kimdre/docker-compose-webhook/internal/config"
+	"github.com/kimdre/doco-cd/internal/config"
 
 	"github.com/docker/cli/cli/command"
 	"github.com/docker/cli/cli/flags"

diff --git a/internal/docker/compose_test.go b/internal/docker/compose_test.go
@@ -9,7 +9,7 @@ import (
 
 	"github.com/docker/compose/v2/pkg/api"
 	"github.com/docker/compose/v2/pkg/compose"
-	"github.com/kimdre/docker-compose-webhook/internal/config"
+	"github.com/kimdre/doco-cd/internal/config"
 )
 
 func createTmpDir(t *testing.T) string {

diff --git a/internal/git/git_test.go b/internal/git/git_test.go
@@ -3,7 +3,7 @@ package git
 import (
 	"fmt"
 	"github.com/google/uuid"
-	"github.com/kimdre/docker-compose-webhook/internal/config"
+	"github.com/kimdre/doco-cd/internal/config"
 	"os"
 	"testing"
 )
@@ -14,10 +14,10 @@ func TestGetAuthUrl(t *testing.T) {
 		t.Fatalf("Failed to get app config: %v", err)
 	}
 
-	expectedUrl := fmt.Sprintf("https://%s:%s@github.com/kimdre/docker-compose-webhook.git", c.AuthType, c.GitAccessToken)
+	expectedUrl := fmt.Sprintf("https://%s:%s@github.com/kimdre/doco-cd.git", c.AuthType, c.GitAccessToken)
 
 	authUrl := GetAuthUrl(
-		"https://github.com/kimdre/docker-compose-webhook.git",
+		"https://github.com/kimdre/doco-cd.git",
 		c.AuthType,
 		c.GitAccessToken,
 	)
@@ -28,7 +28,7 @@ func TestGetAuthUrl(t *testing.T) {
 }
 
 func TestCloneRepository(t *testing.T) {
-	cloneUrl := "https://github.com/kimdre/docker-compose-webhook.git"
+	cloneUrl := "https://github.com/kimdre/doco-cd.git"
 	ref := "refs/heads/main"
 
 	repo, err := CloneRepository(uuid.New().String(), cloneUrl, ref, true)