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

feat: adjust the wizard resume message for known compatibility #629

Merged
merged 3 commits into from
Feb 14, 2025

Conversation

joanise
Copy link
Member

@joanise joanise commented Jan 30, 2025

PR Goal?

The warning about the resume file coming from a different version is too generic. We know 0.2.0 and 0.3.0 resume files are compatible, so adjust the warning to pay attention the which versions are compatible and not.

Feedback sought?

Are the two new messages clearer, and less likely to cause confusion?

Priority?

beta

Tests added?

yes

How to test?

Take an existing save wizard progress file, and edit line 2 to show version 0.3.0 (current), 0.2.0 (older and still compatible) or 0.1.0 (older, not compatible) and see no message, still compat message, or not compat message, respectively.

Confidence?

medium

Version change?

no

Related PRs?

none

Copy link

semanticdiff-com bot commented Jan 30, 2025

Review changes with  SemanticDiff

Changed Files
File Status
  .pre-commit-config.yaml  40% smaller
  everyvoice/wizard/tour.py  18% smaller
  .github/workflows/test.yml  0% smaller
  everyvoice/tests/test_wizard.py  0% smaller
  pyproject.toml Unsupported file format

@joanise joanise requested a review from SamuelLarkin January 30, 2025 18:49
Copy link

codecov bot commented Jan 30, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.31%. Comparing base (a6829b4) to head (6c1f57f).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #629      +/-   ##
==========================================
+ Coverage   76.24%   76.31%   +0.06%     
==========================================
  Files          47       47              
  Lines        3490     3500      +10     
  Branches      481      484       +3     
==========================================
+ Hits         2661     2671      +10     
  Misses        726      726              
  Partials      103      103              

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

Copy link
Contributor

github-actions bot commented Jan 30, 2025

CLI load time: 0:00.27
Pull Request HEAD: 6c1f57ff9ac92327fafe8d48255261ca9bcf5a6e
Imports that take more than 0.1 s:
import time: self [us] | cumulative | imported package
import time:      1052 |     102982 |     typer.main
import time:       275 |     122105 |   typer
import time:      7838 |     200685 | everyvoice.cli

joanise added a commit that referenced this pull request Feb 11, 2025
cases handled:
- recent versions that are known to be compatible
- older version
- back from the future
- wrong software name
@joanise joanise force-pushed the dev.ej/wizard-resume-compat branch from c05e290 to d2781b2 Compare February 11, 2025 15:30
cases handled:
- recent versions that are known to be compatible
- older version
- back from the future
- wrong software name
From CI:
    [WARNING] repo `https://github.com/pre-commit/pre-commit-hooks` uses
    deprecated stage names (commit, push) which will be removed in a future
    version.  Hint: often `pre-commit autoupdate --repo
    https://github.com/pre-commit/pre-commit-hooks` will fix this.  if it does
    not -- consider reporting an issue to that repo.

So I ran

    pre-commit autoupdate --repo https://github.com/pre-commit/pre-commit-hooks

and that does seem to fix the issue since pre-commit-hooks 5.0.0 starts using
the non-deprecated stage names.
See https://github.com/pre-commit/pre-commit-hooks/releases/tag/v5.0.0
@joanise joanise force-pushed the dev.ej/wizard-resume-compat branch from 529e170 to 6c1f57f Compare February 14, 2025 15:41
Copy link
Collaborator

@SamuelLarkin SamuelLarkin left a comment

Choose a reason for hiding this comment

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

LGTM

@joanise joanise merged commit 3fc4ee6 into main Feb 14, 2025
10 checks passed
joanise added a commit that referenced this pull request Feb 14, 2025
cases handled:
- recent versions that are known to be compatible
- older version
- back from the future
- wrong software name
@joanise joanise deleted the dev.ej/wizard-resume-compat branch February 14, 2025 21:57
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.

2 participants