From 99a7bf5a19c37e7f88996738330b5cb16d5bc433 Mon Sep 17 00:00:00 2001 From: "K.B.Dharun Krishna" Date: Thu, 21 Mar 2024 11:48:14 +0530 Subject: [PATCH] chore: add deprecation notice Signed-off-by: K.B.Dharun Krishna --- README.md | 30 ++---------------------------- 1 file changed, 2 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 2e91580..7bb15a4 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,3 @@ +# vib-dnf -# vib-plugin - -A template to create plugins for [vib](https://github.com/vanilla-os/vib) - -## Usage -To use this template, simply fork it and change the module name in go.mod. - -Then you can modify the source in src/plugin.go to create your own plugin. - -We recommend adding the `vib-plugin` tag to your repo so that it can be discovered by other people. - -## Plugin requirements -src/plugin.go explains all requirements for plugins with code examples. -A short tldr: -- vib requires `BuildModule(interface{}, recipe *api.Recipe*) (string, error)` to be available as it is used as the entrypoint for the plugin. Any other functions can be freely declared and will not be used by vib -- Each plugin needs to have a custom struct for the module, with at least two mandatory values: `Name string` and `Type string` -- It is recommended, but not required, to use the api functions for source definition or downloading sources - -## Building -NOTE: Plugins will have to be compiled with the same go version as vib, for builds from vanilla-os, this version is 1.19, it is recommended to use podman/docker or the github workflow to build the plugins. - -Plugins can be built with `go build -trimpath -buildmode=plugin`, which will produce a .so file. -To use the plugin, the .so file has to be moved into the plugins/ directory of the vib recipe. -Plugins are only loaded when required, if a recipe never uses plugin example, example.so will never be loaded. - -This template contains a github workflow that can build the plugin with the right arguments automatically. -Otherwise one can use podman/docker to build the plugin: -`docker run --rm -v "$PWD":/usr/src/myapp -w /usr/src/myapp golang:1.19 go build -trimpath -buildmode=plugin -v` +DNF has been added as a built-in module to Vib directly. So, this repository is no longer required.