Skip to content

Remove deprecated --worker CLI flag#2603

Merged
wizardlyhel merged 7 commits into
mainfrom
rb-remove-cli-flag-deprecations
Oct 24, 2024
Merged

Remove deprecated --worker CLI flag#2603
wizardlyhel merged 7 commits into
mainfrom
rb-remove-cli-flag-deprecations

Conversation

@rbshop
Copy link
Copy Markdown
Contributor

@rbshop rbshop commented Oct 14, 2024

WHY are these changes introduced?

This flag has been deprecated for a while and is due to be removed with the next release

WHAT is this pull request doing?

  • Remove deprecated (and unused) --worker flag

Checklist

  • I've read the Contributing Guidelines
  • I've considered possible cross-platform impacts (Mac, Linux, Windows)
  • I've added a changeset if this PR contains user-facing or noteworthy changes
  • I've added tests to cover my changes
  • I've added or updated the documentation

@shopify
Copy link
Copy Markdown
Contributor

shopify Bot commented Oct 14, 2024

Oxygen deployed a preview of your rb-remove-cli-flag-deprecations branch. Details:

Storefront Status Preview link Deployment details Last update (UTC)
sitemap ✅ Successful (Logs) Preview deployment Inspect deployment October 24, 2024 5:47 PM
third-party-queries-caching ✅ Successful (Logs) Preview deployment Inspect deployment October 24, 2024 5:47 PM
classic-remix ✅ Successful (Logs) Preview deployment Inspect deployment October 24, 2024 5:47 PM
Skeleton (skeleton.hydrogen.shop) ✅ Successful (Logs) Preview deployment Inspect deployment October 24, 2024 5:47 PM
custom-cart-method ✅ Successful (Logs) Preview deployment Inspect deployment October 24, 2024 5:47 PM
metaobjects ✅ Successful (Logs) Preview deployment Inspect deployment October 24, 2024 5:47 PM

Learn more about Hydrogen's GitHub integration.

preview: Flags.boolean({
description:
'Deploys to the Preview environment. Overrides --env-branch and Git metadata.',
'Deploys to the Preview environment. Overrides Git metadata.',
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This previously stated that it Overrides --env-branch, but looking at the original code in this file a little further down it appears that this wasn't actually the case (and I think we should also remove the claim that this overrides the Git metadata too?)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

yes - remove --env-branch comment

overrides Git metadata - @frandiox Does hydrogen deploy preview actually overrides git metadata? I don't see its doing that in code either. Running npx shopify hydrogen deploy --preview just creates a preview deploy with no changes to user's repo (which is expected). I think the metadata here is referring to oxygen specific metadata.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I've reverted the removal of the flag, but I think this update should remain as the code shows that this claim was false anyway

Comment thread packages/cli/src/commands/hydrogen/deploy.ts
@rbshop rbshop added the 2024.10 label Oct 18, 2024
Comment thread .changeset/gorgeous-paws-move.md Outdated
@@ -0,0 +1,5 @@
---
'@shopify/cli-hydrogen': patch
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

@frandiox Should this be a major bump?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Technically yes, but since we are releasing under the bundled global CLI, it doesn't matter much. It's not going to be a major bump in the bundled CLI yet, so feel free to do it in a minor here. It's also been announced as deprecated for very long so it's probably OK.

Copy link
Copy Markdown

@wizardlyhel wizardlyhel left a comment

Choose a reason for hiding this comment

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

Gonna need to revert the changes to --env-branch and leave it in the deprecated state. It can only be remove once --env is supported in CI. Details https://github.com/Shopify/custom-storefronts/issues/560

@rbshop rbshop changed the title Remove deprecated CLI flags Remove deprecated --worker CLI flag Oct 24, 2024
@rbshop
Copy link
Copy Markdown
Contributor Author

rbshop commented Oct 24, 2024

I have now reverted the --env-branch flag and updated the PR description and title accordingly

@wizardlyhel wizardlyhel merged commit da42a2e into main Oct 24, 2024
@wizardlyhel wizardlyhel deleted the rb-remove-cli-flag-deprecations branch October 24, 2024 17:58
juanpprieto pushed a commit that referenced this pull request Sep 17, 2025
Co-authored-by: Helen Lin <helen.lin@shopify.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants