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

BREAKING CHANGE: Drop support for deprecated --wait option in migrate-repo and migrate-org #1083

Merged
merged 5 commits into from
Aug 2, 2023

Conversation

timrogers
Copy link
Contributor

@timrogers timrogers commented Jul 25, 2023

Up until April, the default behavior of migrate-repo and migrate-org was to exit immediately after queueing the migration, and not to wait for it to complete. Users could opt in to the "wait" behaviour using the --wait option.

In April, we flipped these defaults around, making waiting the default and adding the --queue-only option for the old behavior.

This meant that the --wait option could go away - but we wanted to do this in a user-friendly, backwards-compatible way.

At that time, we deprecated the --wait option, hiding it from the in-CLI documentation and printing warning when it's used. These warnings have been in place for 3 months, so now is a reasonable time to rip off the band aid and remove the argument.

After this change is released, specifying the old --wait option will cause the CLI to error.

Fixes #1082 and #1059.

  • Did you write/update appropriate tests
  • Release notes updated (if appropriate)
  • Appropriate logging output
  • Issue linked
  • Docs updated (or issue created)
  • New package licenses are added to ThirdPartyNotices.txt (if applicable)

…ate-repo` and `migrate-org`

Up until April, the default behavior of `migrate-repo` and
`migrate-org` was to exit immediately after queueing the
migration, and not to wait for it to complete. Users could opt
in to the "wait" behaviour using the `--wait` option.

In April, we [flipped][1] these defaults around, making waiting
the default and adding the `--queue-only` option for the old
behavior.

This meant that the `--wait` option could go away - but we wanted
to do this in a user-friendly, backwards-compatible way.

At that time, we deprecated the `--wait` option, hiding it from
the in-CLI documentation and printing warning when it's used.
These warnings have been in place for 3 months, so now is a
reasonable time to rip off the band aid and remove the argument.

After this change is released, specifying the old `--wait` option
will cause the CLI to error.

Fixes #1082 and
#1059.

[1]: #929
@timrogers timrogers requested a review from synthead July 25, 2023 11:38
@timrogers timrogers self-assigned this Jul 25, 2023
@github-actions
Copy link

github-actions bot commented Jul 25, 2023

Unit Test Results

776 tests   776 ✔️  22s ⏱️
    1 suites      0 💤
    1 files        0

Results for commit f918b2f.

♻️ This comment has been updated with latest results.

Copy link
Collaborator

@synthead synthead left a comment

Choose a reason for hiding this comment

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

Wow this is great! I have one small suggestion about the release note!

RELEASENOTES.md Outdated Show resolved Hide resolved
Co-authored-by: Maxwell Pray <[email protected]>
Copy link
Collaborator

@synthead synthead left a comment

Choose a reason for hiding this comment

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

LGTM!

@github-actions
Copy link

github-actions bot commented Aug 2, 2023

Code Coverage

Package Line Rate Branch Rate Complexity Health
Octoshift 86% 75% 1216
ado2gh 84% 81% 601
gei 80% 72% 496
bbs2gh 79% 74% 622
Summary 83% (6523 / 7852) 76% (1477 / 1948) 2935

@timrogers timrogers merged commit 33f5b3a into main Aug 2, 2023
30 checks passed
@timrogers timrogers deleted the timrogers/drop-wait branch August 2, 2023 17:01
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.

Remove support for deprecated --wait option in migrate-repo and migrate-org
3 participants