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: inform users of breaking changes on first run #619

Merged
merged 2 commits into from
Dec 3, 2023

Conversation

SteveLauC
Copy link
Member

@SteveLauC SteveLauC commented Nov 24, 2023

Standards checklist:

  • The PR title is descriptive.
  • I have read CONTRIBUTING.md
  • The code compiles (cargo build)
  • The code passes rustfmt (cargo fmt)
  • The code passes clippy (cargo clippy)
  • The code passes tests (cargo test)
  • Optional: I have tested the code myself

For new steps

  • Optional: Topgrade skips this step where needed
  • Optional: The --dry-run option works with this step
  • Optional: The --yes option works with this step if it is supported by
    the underlying command

If you developed a feature or a bug fix for someone else and you do not have the
means to test it, please tag this person here.


This PR introduces a new feature, informing our users of breaking changes if the Topgrade being executed is a major release and this execution is the first run:

$ ./target/debug/topgrade

── 09:47:31 - Topgrade 13.0.0 Breaking Changes ─────────────────────────────────
No Breaking changes

Confirmed? (y)es/(N)o

A prompt will be printed to ensure the user has confirmed these breaking changes and migrated their configuration file, if not confirmed, Topgrade won't run. This could prevent issues like #605.

@SteveLauC SteveLauC marked this pull request as ready for review December 2, 2023 12:24
@SteveLauC SteveLauC merged commit 788e041 into topgrade-rs:main Dec 3, 2023
7 checks passed
@SteveLauC SteveLauC deleted the breaking_changes branch December 3, 2023 01:52
@hakamadare
Copy link

@SteveLauC this is outstanding, thank you <3

@SteveLauC
Copy link
Member Author

@SteveLauC this is outstanding, thank you <3

I am happy that you enjoy it:)

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