AbsaOSS / AbsaOSS/atum

Move examples to in-repo non-submodule folder

未关闭
#99 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Scala
星标
30
派生
9
PR 合并指标
30 天内没有已合并 PR

描述

The current example* submodules have a couple of shortcomings that would be nice to address:
- they are part of the project build
- so they are released (unnecessarily)
- do not fully document library usage (just import the module, not the built jar)
- currently are not runnable on their own, just as part of the testing runners (this can be leveraged by providing the provided dependencies or compiling those in, also they depend on scala tests, etc.)

Let's take inspiration in [Cobrix](https://github.com/AbsaOSS/cobrix/tree/master/examples). The example apps each have their own `pom.xml`, so they are not part of the build, but they are build-dependent on the main library compatible version.

This way, we can achieve the following:
- clean up the normal build and release
- still have examples as part of the codebase
- have the example apps runnable (via test runners, possibly on its own - optional)

贡献指南

这个仓库没有索引到贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。