diff --git a/.github/workflows/build_and_test.yaml b/.github/workflows/build_and_test.yaml index 6e05bb1..7169c54 100644 --- a/.github/workflows/build_and_test.yaml +++ b/.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 }}" diff --git a/Makefile b/Makefile index 5786a04..02379f2 100644 --- a/Makefile +++ b/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: diff --git a/README.md b/README.md index 1a5059b..52dc255 100644 --- a/README.md +++ b/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) \ No newline at end of file +## 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) + diff --git a/docker-cli-plugins/README.md b/docker-cli-plugins/README.md new file mode 100644 index 0000000..0597808 --- /dev/null +++ b/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 ` + +## 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 \ No newline at end of file diff --git a/docker-cli-plugins/commons/go.mod b/docker-cli-plugins/commons/go.mod new file mode 100644 index 0000000..144127e --- /dev/null +++ b/docker-cli-plugins/commons/go.mod @@ -0,0 +1,3 @@ +module github.com/Makepad-fr/wharf/docker-cli-plugins/commons + +go 1.22.2 diff --git a/docker-plugins/commons/plugin_metadata.go b/docker-cli-plugins/commons/plugin_metadata.go similarity index 100% rename from docker-plugins/commons/plugin_metadata.go rename to docker-cli-plugins/commons/plugin_metadata.go diff --git a/docker-plugins/render/README.md b/docker-cli-plugins/render/README.md similarity index 95% rename from docker-plugins/render/README.md rename to docker-cli-plugins/render/README.md index 4f7c73d..20154e2 100644 --- a/docker-plugins/render/README.md +++ b/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. diff --git a/docker-plugins/render/docker_render.go b/docker-cli-plugins/render/docker_render.go similarity index 96% rename from docker-plugins/render/docker_render.go rename to docker-cli-plugins/render/docker_render.go index b1243e4..6ef0d02 100644 --- a/docker-plugins/render/docker_render.go +++ b/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{ diff --git a/docker-cli-plugins/render/go.mod b/docker-cli-plugins/render/go.mod new file mode 100644 index 0000000..3e0280b --- /dev/null +++ b/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 diff --git a/docker-plugins/render/go.sum b/docker-cli-plugins/render/go.sum similarity index 100% rename from docker-plugins/render/go.sum rename to docker-cli-plugins/render/go.sum diff --git a/docker-plugins/README.md b/docker-plugins/README.md deleted file mode 100644 index 4d3cd8a..0000000 --- a/docker-plugins/README.md +++ /dev/null @@ -1,6 +0,0 @@ -## Wharf Docker Plugin's - -Wharf can be installed as a set of Docker Plugin's and usable with Docker CLI using `docker ` syntax. To install the plugins run `make install-plugins` from the project's root. - -### Plugin List: -- [docker-render](./render/README.md) \ No newline at end of file diff --git a/docker-plugins/commons/go.mod b/docker-plugins/commons/go.mod deleted file mode 100644 index 413bac0..0000000 --- a/docker-plugins/commons/go.mod +++ /dev/null @@ -1,3 +0,0 @@ -module github.com/Makepad-fr/wharf/docker-plugins/commons - -go 1.22.2 diff --git a/docker-plugins/render/go.mod b/docker-plugins/render/go.mod deleted file mode 100644 index 23237f4..0000000 --- a/docker-plugins/render/go.mod +++ /dev/null @@ -1,14 +0,0 @@ -module github.com/Makepad-fr/wharf/docker-plugins/render - -go 1.22.2 - -replace github.com/Makepad-fr/wharf/core => ../../core - -replace github.com/Makepad-fr/wharf/docker-plugins/commons => ../commons - -require ( - github.com/Makepad-fr/wharf/core v0.0.0-00010101000000-000000000000 - github.com/Makepad-fr/wharf/docker-plugins/commons v0.0.0-00010101000000-000000000000 -) - -require gopkg.in/yaml.v3 v3.0.1 // indirect diff --git a/go.work b/go.work index 719adbd..6f1fc7b 100644 --- a/go.work +++ b/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 )