refactor: rename docker-plugins to docker-cli-plugins (#10)

Signed-off-by: Kaan Yagci <[email protected]>

.github/workflows/build_and_test.yaml

@@ -10,7 +10,7 @@ on:
         paths:
             - cli/*$
             - core/**
-            - docker-plugins/**
+            - docker-cli-plugins/**
             - example/**
 concurrency: 
     group: "${{ github.workflow_ref }} - ${{ github.ref }} - ${{ github.event_name }}"

Makefile

@@ -1,5 +1,5 @@
 OUTPUT_FOLDER?=./out
-PLUGINS_OUTPUT_FOLDER?=${OUTPUT_FOLDER}/docker-plugins
+PLUGINS_OUTPUT_FOLDER?=${OUTPUT_FOLDER}/docker-cli-plugins
 DOCKER_PLUGINS_PATH=~/.docker/cli-plugins
 
 .PHONY: build
@@ -11,7 +11,7 @@ build-plugins: ensure-plugins-output-folder-exists build-docker-render
 
 .PHONY: build-docker-render
 build-docker-render:
-	go build -o ${PLUGINS_OUTPUT_FOLDER}/docker-render docker-plugins/render/docker_render.go
+	go build -o ${PLUGINS_OUTPUT_FOLDER}/docker-render docker-cli-plugins/render/docker_render.go
 
 .PHONY: ensure-output-folder-exists
 ensure-output-folder-exists:

README.md

@@ -1,7 +1,11 @@
 # Wharf
 
-A templating system engine for Docker
+A templating system for Dockerfiles.
 
-- [Docker plugins](./docker-plugins/README.md)
-- [CLI](./cli/README.md)
-- [Go dependency](./core/README.md)
+## How to use it?
+
+Wharf can be used in several ways, you can choose how you want to use it
+
+- [Docker CLI Plugins](./docker-cli-plugins/README.md)
+- [Go dependency](./core/README.md)
+<!-- - [CLI](./cli/README.md) -->

docker-cli-plugins/README.md

@@ -0,0 +1,13 @@
+## Using Wharf as Docker CLI Plugin
+
+Docker CLI plugins is used to extend the cappabilities of the Docker CLI. Wharf provide a small list of Docker CLI plugins. You can use them as `docker <plugin>`
+
+## Install
+To install all plugins, you can use the following command from [the project's root.](../)
+
+```bash
+make install-plugins
+```
+
+## List of avaialble plugins:
+- [render](./render/README.md): Create a Dockerfile from a template

docker-cli-plugins/commons/go.mod

@@ -0,0 +1,3 @@
+module github.com/Makepad-fr/wharf/docker-cli-plugins/commons
+
+go 1.22.2

docker-plugins/render/README.md → docker-cli-plugins/render/README.md

@@ -2,10 +2,10 @@
 
 ## Install the Docker plugin
 
-Use the following Makefile command to install the Docker plugin in your current Docker CLI installation
+Use the following command to install the Docker plugin in your current Docker CLI installation
 
 ```bash
-make install
+make install-plugins
 ```
 
 Test the installation using `docker render` from your Terminal.

docker-plugins/render/docker_render.go → docker-cli-plugins/render/docker_render.go

@@ -8,7 +8,7 @@ import (
 	"strings"
 
 	wharf "github.com/Makepad-fr/wharf/core"
-	"github.com/Makepad-fr/wharf/docker-plugins/commons"
+	"github.com/Makepad-fr/wharf/docker-cli-plugins/commons"
 )
 
 var metadata = commons.PluginMetadata{

docker-cli-plugins/render/go.mod

@@ -0,0 +1,14 @@
+module github.com/Makepad-fr/wharf/docker-cli-plugins/render
+
+go 1.22.2
+
+replace github.com/Makepad-fr/wharf/core => ../../core
+
+replace github.com/Makepad-fr/wharf/docker-cli-plugins/commons => ../commons
+
+require (
+	github.com/Makepad-fr/wharf/core v0.0.0-00010101000000-000000000000
+	github.com/Makepad-fr/wharf/docker-cli-plugins/commons v0.0.0-00010101000000-000000000000
+)
+
+require gopkg.in/yaml.v3 v3.0.1 // indirect

go.work

@@ -3,6 +3,6 @@ go 1.22.2
 use (
 	./cli
 	./core
-	./docker-plugins/commons
-	./docker-plugins/render
+	./docker-cli-plugins/commons
+	./docker-cli-plugins/render
 )