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

Remove samples/generated-code as it is duplicated by junit-tests #89

Merged
merged 1 commit into from
Feb 3, 2020

Conversation

macisamuele
Copy link
Collaborator

This PR is created as result of #86 conversation.

The generated-code samples are not much different than groovy-android sample except for the fact that it did contain the generated code. Unfortunately, we were not building, testing or more in general doing something with the code so it was there mostly as a sort showcase of the generator output.

As junit-tests does actually run tests on the generated code, and does include the plugin generated code we might just remove the samples/generated-code by hinting (on the README) the presence of samples/junit-tests as an example of the generated code.

Additionally to that the junit-tests sample does provide a possible implementation of integration tests that allow to verify the behaviour of the APIs and Models.

@macisamuele macisamuele self-assigned this Feb 3, 2020
Copy link
Collaborator

@cortinico cortinico left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚢

@@ -87,6 +85,7 @@ You can find some **examples** in this repository to help you set up your genera
* [samples/kotlin-coroutines](/samples/kotlin-coroutines)<sup>*</sup> Contains an example of an Android Library configured to output Kotlin Coroutines capable code.

* [samples/junit-tests](/samples/junit-tests) This sample contains specs used to test edge cases and scenarios that have been reported in the issue tracker or that are worth testing. Tests are executed using [`moshi-codegen`](https://github.com/square/moshi#codegen).
It does also contains all the generated code inside the `/scr/main/java` folder. You can use this example to see how the generated code will _look like_ (like [here](/samples/junit-tests/src/main/java/com/yelp/codegen/generatecodesamples/apis/ResourceApi.kt)).
Copy link
Collaborator

@cortinico cortinico Feb 3, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you need to add an extra space before this line?

@cortinico cortinico added the infra PR or Issue related to project infrastructure label Feb 3, 2020
@cortinico cortinico added this to the 1.4.0 milestone Feb 3, 2020
@cortinico cortinico merged commit 1e8905e into Yelp:master Feb 3, 2020
@macisamuele macisamuele deleted the maci-remove-generated-code branch February 4, 2020 06:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infra PR or Issue related to project infrastructure
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants