Skip to content

Reorganize the github repository. #1514

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

Merged
merged 2 commits into from
Jul 28, 2022

Conversation

mikereiche
Copy link
Collaborator

Reorganize the github repository to allow addition of a sample/test application
that consumes spring-data-couchbase.

Closes #1503.

  • You have read the Spring Data contribution guidelines.
  • There is a ticket in the bug tracker for the project in our JIRA.
  • You use the code formatters provided here and have them applied to your changes. Don’t submit any formatting related changes.
  • You submit test cases (unit or integration tests) that back your changes.
  • You added yourself as author in the headers of the classes you touched. Amend the date range in the Apache license header if needed. For new types, add the license header (copy from another file and set the current year only).

@mikereiche mikereiche requested review from daschl and mp911de July 21, 2022 23:11
@mp911de
Copy link
Member

mp911de commented Jul 22, 2022

Typically, we do not have samples within the actual Spring Data modules. Instead, there's https://github.com/spring-projects/spring-data-examples/ that is a dedicated place for samples.

What's the motivation behind hosting a sample/test application in the same repo?

@mikereiche
Copy link
Collaborator Author

Hi @mp911de - The main purpose is to include a spring-boot application that consumes spring-data-couchbase. We had an issue last year where I merged a contributed PR that removed a public api that broke the application initialization and we didn't catch that because we only have tests that have application initialization via @SpringJUnitConfig(Config.class) instead of a real spring-boot application.

@mp911de
Copy link
Member

mp911de commented Jul 25, 2022

Having a dependency to Spring Boot does not really work because of the dependency graph. Conceptually, Boot depends on Data and introducing a Boot dependency into a Data repository breaks the separation. If you want to verify the integration in an automated way, I suggest setting up a separate repository that consumes the latest data snapshots.

@mikereiche
Copy link
Collaborator Author

Ugh. That's kind of important. Thanks.

@mikereiche
Copy link
Collaborator Author

Having a dependency to Spring Boot does not really work because of the dependency graph

The intent is to not have a <module> in the parent pom.xml for the sample application - and therefore no cyclic dependency. It would just be located in the same repository, so when cloning spring-data-couchbase, the sample app would be available. It's true that the same could be accomplished in a separate repository, but this would be more convenient and more likely to be used by someone working on spring-data-couchbase.

@mikereiche mikereiche force-pushed the datacouch_1503_reorganize_the_github_repository branch from 368edb6 to 8dd5994 Compare July 28, 2022 21:45
@mikereiche mikereiche force-pushed the datacouch_1503_reorganize_the_github_repository branch from a79c4d1 to a81c94c Compare July 28, 2022 22:09
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 this pull request may close these issues.

reorganize repository into code and sample modules
2 participants