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

Enhance code-migration-detector to allow code analysis. #852

Open
ManuelDittmar opened this issue Apr 15, 2024 · 1 comment
Open

Enhance code-migration-detector to allow code analysis. #852

ManuelDittmar opened this issue Apr 15, 2024 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@ManuelDittmar
Copy link

ManuelDittmar commented Apr 15, 2024

Is your feature request related to a problem? Please describe.

Migration effort can be seen based on the diagram converter, however currently there is no tooling available to analyze the code base.

Describe the solution you'd like

Prevent New Camunda 7 Implementations

User Story

As a system architect,
I want to ensure that no new implementations are added using Camunda 7 specific APIs and patterns,
so that we avoid complicating the upcoming migration to Camunda 8.

Acceptance criteria

  • Given that that a developer is adding or modifying a process solution,
  • when the changes are submitted,
  • then the CI/CD pipeline should automatically check for and reject any use of deprecated Camunda 7 APIs

Tasks

  • Develop ArchUnit rules to detect deprecated Camunda 7 APIs
  • Allow ignoring old violations

On-Demand Reporting of Camunda 7 Migration Challenges

User Story

As a system architect,
I want to have the ability to trigger an analysis that generates a detailed report of Camunda 7 architectural violations
so that I can proactively assess and plan the migration to Camunda 8

Acceptance criteria

  • Given that I trigger the analysis,
  • when the analysis runs on the current codebase,
  • then the tool should evaluate the current code base for Camunda 7-specific architectural violations, generate a detailed report that includes each violation, explains the implications for migration to Camunda 8, and provides suggestions that conform to Camunda 8 best practices, potentially linking to documentation or examples for further guidance.

Tasks

  • Enhance ArchUnit reporting to include detailed violation analysis and migration guidance
  • Document how to generate a report on-demand.

Missing Tests

  • Engine Plugin

Describe alternatives you've considered

Additional context

Implementation will be discussed with @jonathanlukas

@ManuelDittmar ManuelDittmar added the enhancement New feature or request label Apr 15, 2024
@ManuelDittmar ManuelDittmar self-assigned this Apr 15, 2024
@ingorichtsmeier
Copy link
Contributor

I've improved the README with a working MigrationPreparationTest.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants