Skip to content

Drop the Grails 3.x sample as it is incompatible with Spring Framework 5 #637

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

Closed
wilkinsona opened this issue Aug 31, 2019 · 0 comments
Closed
Assignees
Labels
type: documentation Changes to the documentation
Milestone

Comments

@wilkinsona
Copy link
Member

wilkinsona commented Aug 31, 2019

REST Docs 2.0 requires Spring Framework 5 but Grails 3 uses Spring Framework 4.3. This was missed as part of the work on 2.0 and we've got away with it until now, but a recent addition of a call to org.springframework.util.Assert.state(boolean, Supplier<String>) has made the problem apparent.

We do not want to give the false impression that using REST Docs 2.0 with Framework 4.3 is supported. I tried to update the sample to use Grails 4 but it wasn't straightforward. At the time of writing, the top 10 most popular content as shown by GitHub's traffic insight is the following:

  1. https://github.com/spring-projects/spring-restdocs
  2. https://github.com/spring-projects/spring-restdocs/tree/master/samples/rest-notes-spring-data-rest
  3. https://github.com/spring-projects/spring-restdocs/tree/master/samples/rest-notes-spring-data-rest/src
  4. https://github.com/spring-projects/spring-restdocs/tree/master/samples/rest-notes-spring-data-rest/src/main
  5. https://github.com/spring-projects/spring-restdocs/tree/v2.0.3.RELEASE/samples/rest-notes-spring-data-rest
  6. https://github.com/spring-projects/spring-restdocs/tree/master/samples/rest-notes-spring-hateoas
  7. https://github.com/spring-projects/spring-restdocs/tree/master/samples/rest-notes-spring-data-rest/src/main/java/com/example/notes
  8. https://github.com/spring-projects/spring-restdocs/tree/master/samples/web-test-client
  9. https://github.com/spring-projects/spring-restdocs/tree/master/samples
  10. https://github.com/spring-projects/spring-restdocs/tree/master/samples/junit5

Given the relative lack of interest in the sample and its relatively high maintenance cost (#357, #445, #540), I think the best course of action is to remove it. A Grails 4 sample could be added in the future if there's sufficient interest. In the meantime, the Grails sample will continue to be available in the 1.2.x branch.

@wilkinsona wilkinsona added the type: documentation Changes to the documentation label Aug 31, 2019
@wilkinsona wilkinsona added this to the 2.0.4.RELEASE milestone Aug 31, 2019
@wilkinsona wilkinsona self-assigned this Aug 31, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Changes to the documentation
Projects
None yet
Development

No branches or pull requests

1 participant