Skip to content

Comments

Update servlet/architecture.adoc to use include-code#18536

Merged
rwinch merged 2 commits intospring-projects:mainfrom
jkuhel:gh-16226-servlet-architecture
Feb 23, 2026
Merged

Update servlet/architecture.adoc to use include-code#18536
rwinch merged 2 commits intospring-projects:mainfrom
jkuhel:gh-16226-servlet-architecture

Conversation

@jkuhel
Copy link
Contributor

@jkuhel jkuhel commented Jan 21, 2026

This PR updates the servlet architecture (servlet/architecture.adoc) docs to use include-code block macro and included some additional unit tests.

Also updated the docs/antora.xml configuration to add include-xml which is configured to docs/src/test/resources. This allowed the include-code macro to include XML-based snippets (e.g. the creation of the nullRequestCache bean).

The only sample that did not use include-code was the following due to the FilterRegistrationBean from the Spring Boot project not being available.

E.g.

@Bean
public FilterRegistrationBean<TenantFilter> tenantFilterRegistration(TenantFilter filter) {
    FilterRegistrationBean<TenantFilter> registration = new FilterRegistrationBean<>(filter);
    registration.setEnabled(false);
    return registration;
}

References #16226

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Jan 21, 2026
@jkuhel jkuhel force-pushed the gh-16226-servlet-architecture branch from 52cc963 to 7920826 Compare February 16, 2026 00:23
@rwinch rwinch self-assigned this Feb 23, 2026
@rwinch rwinch added in: config An issue in spring-security-config type: enhancement A general enhancement and removed status: waiting-for-triage An issue we've not yet triaged labels Feb 23, 2026
@rwinch rwinch changed the title Update servlet architecture docs to use include-code Update servlet/architecture.adoc to use include-code Feb 23, 2026
Also update antora.xml to include-xml in docs/src/test/resources

Signed-off-by: Joe Kuhel <4983938+jkuhel@users.noreply.github.com>
@rwinch rwinch force-pushed the gh-16226-servlet-architecture branch from 7920826 to 909ee59 Compare February 23, 2026 22:39
@rwinch rwinch added this to the 7.1.0-M3 milestone Feb 23, 2026
@rwinch rwinch enabled auto-merge February 23, 2026 22:40
@rwinch rwinch force-pushed the gh-16226-servlet-architecture branch from 909ee59 to ac7596b Compare February 23, 2026 22:41
@rwinch rwinch changed the base branch from 6.5.x to main February 23, 2026 22:41
@rwinch rwinch force-pushed the gh-16226-servlet-architecture branch from ac7596b to 4c9ee66 Compare February 23, 2026 22:42
@rwinch
Copy link
Member

rwinch commented Feb 23, 2026

Thanks for the PR! There were a few changes that I applied:

  1. I've updated it to use include-code since include-java is not valid. With that update, I also updated the kotlin code to have the disable tag See 4c9ee66
  2. I rebased on main and updated the PR to merge into main. I know the directions said to use 6.5.x (you correctly followed the directions) but the directions were stale so this was a problem on our side (sorry). I've also updated the instructions so that doesn't happen for the next contribution

- Switch `include-java` (does not exist) to `include-code`
- Update kotlin to have the `disable` tag
- Update to suppress deprecation use for User builder (allowed for samples)

Signed-off-by: Robert Winch <362503+rwinch@users.noreply.github.com>
@rwinch rwinch force-pushed the gh-16226-servlet-architecture branch from 4c9ee66 to 0c39469 Compare February 23, 2026 23:04
@rwinch rwinch merged commit e81c64b into spring-projects:main Feb 23, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

in: config An issue in spring-security-config type: enhancement A general enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants