Skip to content

Add v1 to v2 migration guide#250

Merged
tonybaloney merged 2 commits into
masterfrom
migration-guide
Apr 26, 2026
Merged

Add v1 to v2 migration guide#250
tonybaloney merged 2 commits into
masterfrom
migration-guide

Conversation

@tonybaloney
Copy link
Copy Markdown
Owner

Adds a comprehensive migration guide for users upgrading from wily v1 to v2, covering:

  • Cache rebuild: v1 JSON cache is incompatible; users must run \wily clean\ and \wily build\
  • Operator changes: \mccabe\ removed (replaced by \cyclomatic), new \cognitive\ operator added
  • Metric reference table: Complete list of all metrics with their operator and key
  • CLI changes: New --wrap, --table-style, --json\ options; Rich replaces tabulate
  • Dependency changes: radon, mccabe, tabulate removed; Rust backend handles computation
  • Storage format: JSON → Parquet comparison table with schema details
  • Performance improvements: Parallel analysis, Rust-native parsing, columnar storage
  • CI/CD guidance: What to update in pipelines
  • Quick migration checklist

The guide is added as \docs/source/migration_v2.rst\ and linked as the first item in the docs table of contents.

Closes #248

Adds a comprehensive migration guide covering:
- Cache rebuild requirements (JSON -> Parquet)
- Operator changes (mccabe removed, cyclomatic replaces it, cognitive added)
- CLI changes (new --wrap, --table-style, --json options, Rich tables)
- Dependency changes (radon/mccabe/tabulate removed)
- Storage format comparison (JSON vs Parquet)
- Performance improvements
- Quick migration checklist

Closes #248

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Apr 26, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.35%. Comparing base (75669dc) to head (ab71a9c).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #250   +/-   ##
=======================================
  Coverage   90.35%   90.35%           
=======================================
  Files          20       20           
  Lines        1192     1192           
  Branches      161      161           
=======================================
  Hits         1077     1077           
  Misses         87       87           
  Partials       28       28           

☔ View full report in Codecov by Sentry.
📢 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.

- README: Fix Python version requirement (3.6 -> 3.10)
- README: Add -a/--archiver flag to build usage block
- README: Update list-metrics example output for v2 operators
- README: Fix notebook config key (ipynb_support -> include_ipynb)
- README: Add cache_path, include_ipynb, ipynb_cells to config section
- build.rst: Fix --operator to --operators (plural)
- graph.rst: Fix positional metric syntax to use -m flag
- graph.rst: Fix 'wily report' typos that should be 'wily graph'
- graph.rst: Fix --shared=js to --shared-js
- graph.rst: Add missing 'wily graph' subcommand in examples
- index.rst: Add -m flag to graph example
- report.rst: Fix default metrics description (uses all metrics, not a subset)
- rank.rst: Remove undocumented --threshold option
- ci.rst: Update GitHub Actions to v4, remove hardcoded wily version
- ci.rst: Replace deprecated ::set-output with GITHUB_OUTPUT

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@tonybaloney tonybaloney merged commit 457096c into master Apr 26, 2026
26 checks passed
@tonybaloney tonybaloney deleted the migration-guide branch April 26, 2026 04:00
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.

Add v1 -> v2 migration guide to documentation

2 participants