Skip to content

Document maintenance status and migration - #620

Merged
koxudaxi merged 2 commits into
mainfrom
document-maintenance-status
Oct 22, 2026
Merged

koxudaxi merged 2 commits into
mainfrom
document-maintenance-status

Conversation

@koxudaxi

@koxudaxi koxudaxi commented Oct 22, 2026 •

Copy link
Copy Markdown
Owner

Fixes: #619

Summary by CodeRabbit

  • Documentation
    • Updated the project documentation to state that fastapi-code-generator is no longer maintained.
    • Added guidance for new projects and migrations, including a link to the migration guide. The guide notes that migration requires changes to generation workflows and application code.
    • Clarified that the replacement’s FastAPI server and Python client generation are experimental and may change. Existing documentation remains available as a reference.

@github-actions

Copy link
Copy Markdown
Contributor

📚 Docs Preview: https://pr-620.fastapi-code-generator.pages.dev

@codspeed

codspeed Bot commented Oct 22, 2026

Copy link
Copy Markdown

Merging this PR will improve performance by 84.01%

2 warnings

⚠️ Walltime results may be unreliable

Some benchmarks used the Walltime instrument outside CodSpeed Macro Runners, which can make the results inconsistent.

Learn more about Macro Runners

See affected benchmarks

⚠️ Base and head ran on different runner types

Some benchmarks with significant performance changes were compared across different runner types, so the changes might not come from the code. Run base and head on the same runner type, or use CodSpeed Macro Runners for more stable results.

Learn more about Macro Runners

Open the report in CodSpeed to investigate

⚡ 1 improved benchmark

Performance Changes

Benchmark BASE HEAD Efficiency
⚡ test_generate_default_template_benchmark 39.6 ms 21.5 ms +84.01%

Tip

Curious why performance improved? Comment @codspeedbot explain why performance improved on this PR, or directly use the CodSpeed MCP with your agent.


Comparing document-maintenance-status (ebda2e4) with main (b3b9bd6)

Open in CodSpeed

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-22T16:51:49.723980Z ebda2e4 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@coderabbitai

coderabbitai Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: c155b243-b273-4b8c-89ca-7316d05a967d
📥 Commits

Reviewing files that changed from the base of the PR and between b3b9bd6 and ebda2e4.

⛔ Files ignored due to path filters: 1
  • uv.lock is excluded by !**/*.lock
📒 Files selected for processing: 4
  • README.md
  • docs/index.md
  • docs/llms-full.txt
  • pyproject.toml

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

Walkthrough

The README and documentation now state that fastapi-code-generator is no longer maintained and provide migration guidance. The twine minimum version in pyproject.toml increases from 6.1 to 7.0.

Changes

Maintenance and migration notice

Layer / File(s) Summary
Add maintenance and migration guidance
README.md, docs/index.md, docs/llms-full.txt
The documentation states that the project is no longer maintained, points new projects and migrations to datamodel-code-generator, and links to migration guidance. It notes that migration requires workflow and application-code changes. The README and documentation remain available as references.

Packaging dependency update

Layer / File(s) Summary
Raise the twine minimum version
pyproject.toml
The pkg-meta development dependency requirement for twine increases from >=6.1 to >=7.0.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to ebda2

This change adds a maintenance and migration notice to the docs and raises the minimum twine version for package validation. The lockfile is already updated to match, so there is no remaining merge risk.

Pre-merge checks: Passed 4 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Out of Scope Changes check Warning The README and generated documentation notices support issue #619. The pyproject.toml change updates the twine development dependency from >=6.1 to >=7.0. This metadata-validation dependency c… Remove the unrelated twine dependency update from this pull request, or move it to a separate pull request.
Passed Passed checks: 4 passed
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main changes: documenting the project's maintenance status and migration path.
Linked Issues check Passed Issue #619 requires a short README note with links to FastAPI Server Generation and the migration guide. The README change adds a maintenance and migration notice, directs users to the experimental Fa…
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Full details: Linked Issues check

Explanation

Issue #619 requires a short README note with links to FastAPI Server Generation and the migration guide. The README change adds a maintenance and migration notice, directs users to the experimental FastAPI server generation, and links the migration guide. The linked issue's coding requirement is met. No automated test is required for this documentation-only requirement.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (4 skipped: 4 unsupported.)

Full details: Out of Scope Changes check

Explanation

The README and generated documentation notices support issue #619. The pyproject.toml change updates the twine development dependency from >=6.1 to >=7.0. This metadata-validation dependency change has no demonstrated connection to the README documentation requirement.

Resolution

Remove the unrelated twine dependency update from this pull request, or move it to a separate pull request.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

A rabbit reads the notice clear,
New paths and guidance now appear.
The old pages stay in view,
While twine gets a version new.
I nibble, hop, and mark the change!

Comment @coderabbitai help to get the list of available commands.

@codecov

codecov Bot commented Oct 22, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (b3b9bd6) to head (ebda2e4).

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #620   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           17        17           
  Lines         1548      1548           
  Branches       163       163           
=========================================
  Hits          1548      1548           
Flag Coverage Δ
unittests 100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Owner Author

@coderabbitai The Twine update is a prerequisite for passing this PR's CI. The existing main branch already fails Package metadata because Twine 6.2 rejects metadata version 2.5: InvalidDistribution: Invalid distribution metadata: '2.5' is not a valid metadata version.

I reproduced that failure locally. Twine 7.0 fixes metadata 2.5 support, and both tox run -e pkg_meta and this PR's package validation now pass. The update only changes the package-validation development dependency and its lockfile entries, in a separate commit (13a59b6).

Please reconsider the out-of-scope warning in light of this required CI fix.

@coderabbitai

coderabbitai Bot commented Oct 22, 2026

Copy link
Copy Markdown

Tip

For best results, initiate chat on the files or code changes.

@koxudaxi I couldn't produce a complete response to this request. Please try again.

You are interacting with an AI system.

@koxudaxi
koxudaxi merged commit 7fd4ee2 into main Oct 22, 2026
45 checks passed
@koxudaxi
koxudaxi deleted the document-maintenance-status branch October 22, 2026 17:00
@github-actions github-actions Bot added the breaking-change-analyzed PR has been checked for release draft updates label Oct 22, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Breaking Change Analysis

Result: No breaking changes detected

Reasoning: PR #620 only adds documentation sections (README.md, docs/index.md, docs/llms-full.txt) announcing the project's maintenance status and migration guidance to datamodel-code-generator. The only code change is bumping the twine dev dependency from >=6.1 to >=7.0 in pyproject.toml/uv.lock, which is a development-only tool and does not affect users of the library. No source code, templates, CLI options, default behaviors, generated output, error handling, or Python/dependency compatibility were changed.


This analysis was performed by Claude Code Action

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

breaking-change-analyzed PR has been checked for release draft updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Point README to datamodel-code-generator's FastAPI server generation

1 participant