Skip to content

Conversation

@GaneshPatil7517
Copy link
Contributor

Description

This PR adds a comprehensive migration guide for developers upgrading Apache Shiro across major versions. The guide addresses the changes outlined in issue #271 and provides clear, actionable documentation for the following migration paths:

Migrating from 1.x to 2.x

  • Java 8 → Java 11 minimum requirement
  • Jakarta EE 8-11 support using jakarta classifiers
  • Spring Boot 2.x and 3.x compatibility with appropriate dependencies

Migrating from 2.x to 3.x

  • Java 11 → Java 17 minimum requirement
  • Native Jakarta EE 10-11 support (no classifiers needed)
  • Spring Boot 4 compatibility
  • Security behavior changes:
    • Deny access by default (previously allow-all)
    • Case-insensitive URL matching enabled by default
    • CORS preflight requests enabled by default

Configuration Examples

  • shiro.ini and Spring Boot application.properties examples
  • Instructions for reverting to legacy behavior when necessary

Common Migration Pitfalls

  • Documented typical issues developers encounter during migration

Testing

  • Built the site locally using mvn process-classes
  • Verified the migration guide renders correctly at target/website/migration-guide.html
  • Confirmed navigation links work from both the Guides and Documentation pages

Related Issue

Closes #271

Copilot AI review requested due to automatic review settings January 19, 2026 09:16
@GaneshPatil7517 GaneshPatil7517 mentioned this pull request Jan 19, 2026
9 tasks
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds a comprehensive migration guide for Apache Shiro, helping developers upgrade from version 1.x through 2.x to 3.x. The guide covers Java version requirements, Jakarta EE namespace transitions, Spring Boot compatibility, and important security behavior changes in version 3.x.

Changes:

  • Added new migration-guide.adoc with detailed upgrade instructions for Shiro 1.x → 2.x → 3.x
  • Updated guides.adoc to include a link to the new migration guide
  • Updated documentation.adoc to include a link to the new migration guide

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
src/site/content/migration-guide.adoc New comprehensive migration guide covering version requirements, Jakarta EE support, Spring Boot compatibility, and security behavior changes across Shiro versions
src/site/content/guides.adoc Added navigation link to the migration guide
src/site/content/documentation.adoc Added navigation link to the migration guide in the reference manual section

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@lprimak
Copy link
Contributor

lprimak commented Jan 21, 2026

Thanks again Ganesh! Great work

@lprimak lprimak merged commit ef8f49b into apache:main Jan 21, 2026
2 checks passed
@GaneshPatil7517
Copy link
Contributor Author

Thanks again Ganesh! Great work

you are welcome @lprimak feel free to assign more issues....

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.

Create Migration Guide

2 participants