diff --git a/community/v1.0.0/INDEX b/community/v1.0.0/INDEX new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/community/v1.0.0/INDEX @@ -0,0 +1 @@ + diff --git a/community/v1.0.0/README.md b/community/v1.0.0/README.md new file mode 100644 index 0000000..51919da --- /dev/null +++ b/community/v1.0.0/README.md @@ -0,0 +1,63 @@ +# plugins + +This repository stores the recipes to locate, build and install plugins for PlakarKorp's software. + + +## Is being listed to this repository mandatory ? + +No, you are free to develop your own integrations, +build them and distribute them yourself through your own means. + +Documentation is available on our website on how to proceed. + + +## Why should I get my integration listed ? + +Very simple, if your integration is listed here, +your users will be able to locate the plugins more easily, +install them straight from our UI with one-click, +and have shortcuts on the CLI. + +The following will locate the recipe for the integration named `foobar`, +resolve it into a repository and install the package pre-built for the system and architecture: + +``` +$ plakar pkg add foobar +``` + +If no pre-built package exists, +then users can still do the following to build your plugin: + +``` +$ plakar pkg build foobar +[...] +plugin created: foobar_v1.0.0_openbsd_arm64.ptar +``` + +and install it with: +``` +$ plakar pkg add ./foobar_v1.0.0_openbsd_arm64.ptar +``` + +Basically, +get your integration listed if you want it to have a broader user-base, +don't if you prefer to distribute yourself or if your integration is closed-source. + + + +## How to get my integration listed here ? + +To have your integration listed here, +you need to open a pull request with a `recipe.yaml` describing the name of your integration, +the repository where your code resides, +the semver tag for a particular version, +and the checksum of that tag: + +```yaml +name: imap +version: v0.1.0-devel.697fd98 +repository: https://github.com/PlakarKorp/integration-imap +checksum: 697fd983ee4fecc91396af0e34dbe52fcda0f1fe +``` + +Our team will then validate the PR and add you to the listing. \ No newline at end of file diff --git a/community/v1.0.0/caldav/recipe.yaml b/community/v1.0.0/caldav/recipe.yaml new file mode 100644 index 0000000..acf0fed --- /dev/null +++ b/community/v1.0.0/caldav/recipe.yaml @@ -0,0 +1,4 @@ +name: caldav +version: v1.0.0-beta.8 +repository: https://github.com/PlakarKorp/integration-caldav +checksum: sha256:bbadbeef15adeadbeefea7deadbeef diff --git a/community/v1.0.0/ftp/recipe.yaml b/community/v1.0.0/ftp/recipe.yaml new file mode 100644 index 0000000..d5a615c --- /dev/null +++ b/community/v1.0.0/ftp/recipe.yaml @@ -0,0 +1,4 @@ +name: ftp +version: v1.0.7 +repository: https://github.com/PlakarKorp/integration-ftp +checksum: sha256:bbadbeef15adeadbeefea7deadbeef diff --git a/community/v1.0.0/gcs/recipe.yaml b/community/v1.0.0/gcs/recipe.yaml new file mode 100644 index 0000000..8672559 --- /dev/null +++ b/community/v1.0.0/gcs/recipe.yaml @@ -0,0 +1,4 @@ +name: gcs +version: v1.0.8 +repository: https://github.com/PlakarKorp/integration-gcs +checksum: sha256:bbadbeef15adeadbeefea7deadbeef diff --git a/community/v1.0.0/http/recipe.yaml b/community/v1.0.0/http/recipe.yaml new file mode 100644 index 0000000..58160a2 --- /dev/null +++ b/community/v1.0.0/http/recipe.yaml @@ -0,0 +1,4 @@ +name: http +version: v1.0.5 +repository: https://github.com/PlakarKorp/integration-http +checksum: sha256:abadbeef15adeadbeefea7deadbeef diff --git a/community/v1.0.0/imap/recipe.yaml b/community/v1.0.0/imap/recipe.yaml new file mode 100644 index 0000000..b1deec7 --- /dev/null +++ b/community/v1.0.0/imap/recipe.yaml @@ -0,0 +1,4 @@ +name: imap +version: v1.0.0-rc3 +repository: https://github.com/PlakarKorp/integration-imap +checksum: sha256:abadbeef15adeadbeefea7deadbeef diff --git a/community/v1.0.0/notion/recipe.yaml b/community/v1.0.0/notion/recipe.yaml new file mode 100644 index 0000000..dd31a02 --- /dev/null +++ b/community/v1.0.0/notion/recipe.yaml @@ -0,0 +1,4 @@ +name: notion +version: v1.0.0-beta.3 +repository: https://github.com/PlakarKorp/integration-notion +checksum: sha256:abadbeef15adeadbeefea7deadbeef diff --git a/community/v1.0.0/rclone/recipe.yaml b/community/v1.0.0/rclone/recipe.yaml new file mode 100644 index 0000000..591f4de --- /dev/null +++ b/community/v1.0.0/rclone/recipe.yaml @@ -0,0 +1,4 @@ +name: rclone +version: v1.0.0-beta.6 +repository: https://github.com/PlakarKorp/integration-rclone +checksum: sha256:abadbeef15adeadbeefea7deadbeef diff --git a/community/v1.0.0/s3/recipe.yaml b/community/v1.0.0/s3/recipe.yaml new file mode 100644 index 0000000..9918a75 --- /dev/null +++ b/community/v1.0.0/s3/recipe.yaml @@ -0,0 +1,4 @@ +name: s3 +version: v1.0.7 +repository: https://github.com/PlakarKorp/integration-s3 +checksum: sha256:abadbeef15adeadbeefea7deadbeef diff --git a/community/v1.0.0/sftp/recipe.yaml b/community/v1.0.0/sftp/recipe.yaml new file mode 100644 index 0000000..c6c5937 --- /dev/null +++ b/community/v1.0.0/sftp/recipe.yaml @@ -0,0 +1,4 @@ +name: sftp +version: v1.0.8 +repository: https://github.com/PlakarKorp/integration-sftp +checksum: sha256:abadbeef15adeadbeefea7deadbeef diff --git a/community/v1.0.0/sqlite/recipe.yaml b/community/v1.0.0/sqlite/recipe.yaml new file mode 100644 index 0000000..74c3d2a --- /dev/null +++ b/community/v1.0.0/sqlite/recipe.yaml @@ -0,0 +1,4 @@ +name: sqlite +version: v1.0.5 +repository: https://github.com/PlakarKorp/integration-sqlite +checksum: sha256:abadbeef15adeadbeefea7deadbeef diff --git a/INDEX b/community/v1.1.0/INDEX similarity index 100% rename from INDEX rename to community/v1.1.0/INDEX diff --git a/Makefile b/community/v1.1.0/Makefile similarity index 100% rename from Makefile rename to community/v1.1.0/Makefile diff --git a/community/v1.1.0/README.md b/community/v1.1.0/README.md new file mode 100644 index 0000000..51919da --- /dev/null +++ b/community/v1.1.0/README.md @@ -0,0 +1,63 @@ +# plugins + +This repository stores the recipes to locate, build and install plugins for PlakarKorp's software. + + +## Is being listed to this repository mandatory ? + +No, you are free to develop your own integrations, +build them and distribute them yourself through your own means. + +Documentation is available on our website on how to proceed. + + +## Why should I get my integration listed ? + +Very simple, if your integration is listed here, +your users will be able to locate the plugins more easily, +install them straight from our UI with one-click, +and have shortcuts on the CLI. + +The following will locate the recipe for the integration named `foobar`, +resolve it into a repository and install the package pre-built for the system and architecture: + +``` +$ plakar pkg add foobar +``` + +If no pre-built package exists, +then users can still do the following to build your plugin: + +``` +$ plakar pkg build foobar +[...] +plugin created: foobar_v1.0.0_openbsd_arm64.ptar +``` + +and install it with: +``` +$ plakar pkg add ./foobar_v1.0.0_openbsd_arm64.ptar +``` + +Basically, +get your integration listed if you want it to have a broader user-base, +don't if you prefer to distribute yourself or if your integration is closed-source. + + + +## How to get my integration listed here ? + +To have your integration listed here, +you need to open a pull request with a `recipe.yaml` describing the name of your integration, +the repository where your code resides, +the semver tag for a particular version, +and the checksum of that tag: + +```yaml +name: imap +version: v0.1.0-devel.697fd98 +repository: https://github.com/PlakarKorp/integration-imap +checksum: 697fd983ee4fecc91396af0e34dbe52fcda0f1fe +``` + +Our team will then validate the PR and add you to the listing. \ No newline at end of file diff --git a/etcd/recipe.yaml b/community/v1.1.0/etcd/recipe.yaml similarity index 100% rename from etcd/recipe.yaml rename to community/v1.1.0/etcd/recipe.yaml diff --git a/ftp/recipe.yaml b/community/v1.1.0/ftp/recipe.yaml similarity index 100% rename from ftp/recipe.yaml rename to community/v1.1.0/ftp/recipe.yaml diff --git a/gcs/recipe.yaml b/community/v1.1.0/gcs/recipe.yaml similarity index 100% rename from gcs/recipe.yaml rename to community/v1.1.0/gcs/recipe.yaml diff --git a/imap/recipe.yaml b/community/v1.1.0/imap/recipe.yaml similarity index 100% rename from imap/recipe.yaml rename to community/v1.1.0/imap/recipe.yaml diff --git a/k8s/recipe.yaml b/community/v1.1.0/k8s/recipe.yaml similarity index 100% rename from k8s/recipe.yaml rename to community/v1.1.0/k8s/recipe.yaml diff --git a/notion/recipe.yaml b/community/v1.1.0/notion/recipe.yaml similarity index 100% rename from notion/recipe.yaml rename to community/v1.1.0/notion/recipe.yaml diff --git a/oci/recipe.yaml b/community/v1.1.0/oci/recipe.yaml similarity index 100% rename from oci/recipe.yaml rename to community/v1.1.0/oci/recipe.yaml diff --git a/rclone/recipe.yaml b/community/v1.1.0/rclone/recipe.yaml similarity index 100% rename from rclone/recipe.yaml rename to community/v1.1.0/rclone/recipe.yaml diff --git a/s3/recipe.yaml b/community/v1.1.0/s3/recipe.yaml similarity index 100% rename from s3/recipe.yaml rename to community/v1.1.0/s3/recipe.yaml diff --git a/sftp/recipe.yaml b/community/v1.1.0/sftp/recipe.yaml similarity index 100% rename from sftp/recipe.yaml rename to community/v1.1.0/sftp/recipe.yaml diff --git a/sqlite/recipe.yaml b/community/v1.1.0/sqlite/recipe.yaml similarity index 100% rename from sqlite/recipe.yaml rename to community/v1.1.0/sqlite/recipe.yaml