{"id":21296690,"url":"https://github.com/eccenca/silk-plugin-template","last_synced_at":"2025-06-13T04:04:40.581Z","repository":{"id":70032030,"uuid":"199475589","full_name":"eccenca/silk-plugin-template","owner":"eccenca","description":"A template for silk plugins.","archived":false,"fork":false,"pushed_at":"2019-08-12T12:30:49.000Z","size":7,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-22T07:20:16.591Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eccenca.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-07-29T15:07:14.000Z","updated_at":"2019-08-12T12:30:51.000Z","dependencies_parsed_at":null,"dependency_job_id":"d3830b36-8942-4f96-bbd8-d43de32b6091","html_url":"https://github.com/eccenca/silk-plugin-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eccenca%2Fsilk-plugin-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eccenca%2Fsilk-plugin-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eccenca%2Fsilk-plugin-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eccenca%2Fsilk-plugin-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eccenca","download_url":"https://codeload.github.com/eccenca/silk-plugin-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243764644,"owners_count":20344457,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-21T14:29:02.951Z","updated_at":"2025-03-15T17:26:17.440Z","avatar_url":"https://github.com/eccenca.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Silk Plugin Template\nA template for [silk](https://github.com/silk-framework/silk) plugins containing a transformer class plugin example.\nThese plugins are either usable by silk directly (pls. follow the instructions for silk usage) or by eccenca Dataintegration.\n\n# Building the plugin\n\nThe libraries of DataIntegration are needed to build the plugin (also during developing the plugin). Checkout the targeted version of DataIntegratio or Silk and run `./sbt publishLocal`\nExecute `sbt package`. \n\n# Installing the plugin\n\nThe resulting jar in `target/scala-2.11/` needs to be put into the configured plugin directory.\n\nSilk: use the sbt parameter --sbt-dir to point to the plugin directory\n\nDataintegration: The plugin directory is configured in the DataIntegration configuration with the property `pluginRegistry.pluginFolder = ${elds.home}\"/etc/dataintegration/plugins/\"\n`\n\n# Important Notes\n\n- __A plugin is always build against a certain version of Dataintegration / Silk__\n  - Rebuilding the pluging Jar is necessary if dependencies of Dataintegration change, as i might reference different library versions (dependency changes can happen in patch level verion increases)\n- __Depending on what the plugin does, code chages are needed if internal APIs of Dataintegration change__\n  - If the plugin defines a task and implements a task executor, it might be the case that changes are needed, except when high level APIs (e.g. the [???]Task interfaces, [???]Entity result type changes) - it is rare, though\n  - If the plugin uses other plugins or a large number of existing operators/datasets, changes between 2 release are more likely\n\n# Upgrade Notes\n\n## General considerationswhen the version of Dataintegration or Silk changes\n\n- Always rebuild the plugin, even when only the patch version is increased:\n\n```\ncd dataintegration-repo\ngit checkout vX.X.X\n./sbt publishLocal\n# sometimes a clean is needed\n# rm -rf ~/.ivy2/* makes sure that no old jars remain\n\ncd pluginRepo\n./sbt package\n```\n\n- Check the log output of the whole process\n  - Deprecation warnings can be ignored\n  - Eviction wanings should be taken serious - if they name a dependency that is used directly by the plugin, they should be adressed\n  - Errors have to be addressed in some way\n  - Warning diretly related to code in the plugin, especially when not thrown in the last version, should also be adressed\n\n- Plugins should be versioned: Since they might be branches of this repository the version should be  ```[plugin id]-v[dataintegration version]-[plugin version]```\n\n-Is the plugin an operator, dataset or rule implemetation? __Make it serializable__ (with Serializable trait, lazy transient vals, etc. ask Christian Wartner)\n\n- Always check if for configuration values or their default values, esp. when the plugin uses them directly\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feccenca%2Fsilk-plugin-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feccenca%2Fsilk-plugin-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feccenca%2Fsilk-plugin-template/lists"}