Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move examples to in-repo non-submodule folder #99

Open
dk1844 opened this issue Jul 21, 2021 · 0 comments · Fixed by #106
Open

Move examples to in-repo non-submodule folder #99

dk1844 opened this issue Jul 21, 2021 · 0 comments · Fixed by #106
Milestone

Comments

@dk1844
Copy link
Collaborator

dk1844 commented Jul 21, 2021

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. 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)
@dk1844 dk1844 added this to the 4.0.0 milestone Jul 21, 2021
dk1844 added a commit that referenced this issue Jul 30, 2021
dk1844 added a commit that referenced this issue Aug 2, 2021
dk1844 added a commit that referenced this issue Aug 2, 2021
dk1844 added a commit that referenced this issue Aug 2, 2021
dk1844 added a commit that referenced this issue Aug 2, 2021
dk1844 added a commit that referenced this issue Aug 2, 2021
dk1844 added a commit that referenced this issue Aug 2, 2021
dk1844 added a commit that referenced this issue Aug 2, 2021
dk1844 added a commit that referenced this issue Aug 2, 2021
dk1844 added a commit that referenced this issue Aug 2, 2021
@dk1844 dk1844 linked a pull request Aug 5, 2021 that will close this issue
dk1844 added a commit that referenced this issue Aug 12, 2021
dk1844 added a commit that referenced this issue Aug 12, 2021
…release.plugin.version, scala.cross.build.maven.plugin.version)

 - licence check update (exclusions), workflow
dk1844 added a commit that referenced this issue Aug 12, 2021
dk1844 added a commit that referenced this issue Aug 24, 2021
* #99 examples in a subfolder,
* #99 README.md update
* #99 encoding added to example projects
* #99 span scale factor = 10 for GH action
* #99 copyright year update
* #99 explicit plugin versions moved to properties (build plugin maven.release.plugin.version, scala.cross.build.maven.plugin.version)
* #99 SampleMeasurementsIntegrationSuite companion object moved in front of the class
#103 (comment)
Co-authored-by: Saša Zejnilović <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant