feat(create-mc-app): add cloudIdentifier flag #3564

mustafaasif2 · 2024-07-03T13:16:21Z

Summary

Added a cloudIdentifier flag for Custom Applications and Custom Views

Description

The create-mc-app CLI now prompts the user about the region of their choice, defaulting to gcp-eu.

The option to define the region is also be possible via a CLI option, e.g. --cloud-identifier=gcp-au for programmatic usage.

Background

Installing one of the Merchant Center starter templates (customizations) results by default in using the GCP EU environment.

However, for customers using a different CoCo region it might get confusing if they forget to change the cloudIdentifier to the region of their choice.

Corresponding Jira Ticket: SHIELD-1300

changeset-bot · 2024-07-03T13:16:25Z

🦋 Changeset detected

Latest commit: 8bda236

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 36 packages

Name	Type
@commercetools-frontend/create-mc-app	Minor
@commercetools-applications/merchant-center-template-starter-typescript	Minor
@commercetools-applications/merchant-center-template-starter	Minor
@commercetools-applications/merchant-center-custom-view-template-starter-typescript	Minor
@commercetools-applications/merchant-center-custom-view-template-starter	Minor
@commercetools-backend/eslint-config-node	Minor
@commercetools-backend/express	Minor
@commercetools-backend/loggers	Minor
@commercetools-frontend/actions-global	Minor
@commercetools-frontend/application-components	Minor
@commercetools-frontend/application-config	Minor
@commercetools-frontend/application-shell-connectors	Minor
@commercetools-frontend/application-shell	Minor
@commercetools-frontend/assets	Minor
@commercetools-frontend/babel-preset-mc-app	Minor
@commercetools-frontend/browser-history	Minor
@commercetools-frontend/codemod	Minor
@commercetools-frontend/constants	Minor
@commercetools-frontend/cypress	Minor
@commercetools-frontend/eslint-config-mc-app	Minor
@commercetools-frontend/i18n	Minor
@commercetools-frontend/jest-preset-mc-app	Minor
@commercetools-frontend/jest-stylelint-runner	Minor
@commercetools-frontend/l10n	Minor
@commercetools-frontend/mc-dev-authentication	Minor
@commercetools-frontend/mc-html-template	Minor
@commercetools-frontend/mc-scripts	Minor
@commercetools-frontend/notifications	Minor
@commercetools-frontend/permissions	Minor
@commercetools-frontend/react-notifications	Minor
@commercetools-frontend/sdk	Minor
@commercetools-frontend/sentry	Minor
@commercetools-frontend/url-utils	Minor
@commercetools-local/playground	Minor
@commercetools-local/visual-testing-app	Minor
@commercetools-website/components-playground	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

vercel · 2024-07-03T13:16:26Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
mc-app-kit-playground	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 10, 2024 7:39am
merchant-center-application-kit-components-playground	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 10, 2024 7:39am

…optional

mustafaasif2 · 2024-07-03T14:25:42Z

Some general questions:

Is the pipeline failing because of my changes or is it supposed to fail in the development environment. The error message that shows up is "Error: The operation was canceled."
I tried generating a changeset file, however, I was not completely sure on the options to select while creating one for these changes.

packages/create-mc-app/src/process-options.ts

packages/create-mc-app/src/constants.ts

kark

Thank you for looking into this! Congrats on your first PR 🥳 It looks really good 🤗

Some general questions:

Is the pipeline failing because of my changes or is it supposed to fail in the development environment. The error message that shows up is "Error: The operation was canceled."

Yes, the pipeline step runs scripts/install-template.mjs script.
The cli prompts for cloud env, which is not provided in the script.

merchant-center-application-kit/scripts/install-template.mjs

Lines 56 to 67 in 67a35e2

    
           const createAppCmdResult = shelljs.exec( 
        
             [ 
        
               binaryPath, 
        
               applicationName, 
        
               `--template=${templateName}`, 
        
               `--template-version=${branchName}`, 
        
               `--application-type=${applicationType}`, 
        
               `--initial-project-key=${initialProjectKey}`, 
        
               `--yes`, 
        
               '--skip-install', 
        
             ].join(' '), 
        
             { cwd: sandboxPath }

I tried generating a changeset file, however, I was not completely sure on the options to select while creating one for these changes.

We use semantic versioning. A new feature (a non-breaking change) corresponds to a minor package update

packages/create-mc-app/src/constants.ts

packages/create-mc-app/src/process-options.ts

emmenko

Great job so far, thanks! 🙌

packages/create-mc-app/src/process-options.ts

…tion-config and added CLOUD_IDENTIFIER env variable

…updated lock file

kark

Thanks again, everything looks good to me 🙌
Here are my final comments

packages/create-mc-app/src/validations.ts

.changeset/great-rules-grin.md

…nt code Co-authored-by: Kacper Krzywiec <[email protected]>

… CLOUD_IDENTIFIERS

kark

Thanks, looks great 😊
2 final notes

.changeset/great-rules-grin.md

packages/create-mc-app/src/cli.ts

emmenko

Awesome work, thanks a lot! 🙌

All good from my side, just a minor naming suggestion.

packages/create-mc-app/src/validations.ts

…for clarity

Rhotimee

Nice work @mustafaasif2 🙌🏽

feat(create-mc-app): add cloudIdentifier flag

40fd455

mustafaasif2 self-assigned this Jul 3, 2024

fix(types): updated the cloudIdentifier in TCliTaskOptions to not be …

b43c7d9

…optional

vercel bot deployed to Preview – merchant-center-application-kit-components-playground July 3, 2024 13:44 View deployment

vercel bot deployed to Preview – mc-app-kit-playground July 3, 2024 13:45 View deployment

mustafaasif2 commented Jul 3, 2024

View reviewed changes

packages/create-mc-app/src/process-options.ts Show resolved Hide resolved

mustafaasif2 commented Jul 3, 2024

View reviewed changes

packages/create-mc-app/src/constants.ts Outdated Show resolved Hide resolved

kark reviewed Jul 3, 2024

View reviewed changes

packages/create-mc-app/src/constants.ts Outdated Show resolved Hide resolved

packages/create-mc-app/src/process-options.ts Show resolved Hide resolved

emmenko reviewed Jul 4, 2024

View reviewed changes

packages/create-mc-app/src/process-options.ts Show resolved Hide resolved

refactor(create-mc-app): used CLOUD_IDENTIFIERS constant from applica…

1dc901c

…tion-config and added CLOUD_IDENTIFIER env variable

vercel bot had a problem deploying to Preview – merchant-center-application-kit-components-playground July 4, 2024 11:50 Failure

vercel bot had a problem deploying to Preview – mc-app-kit-playground July 4, 2024 11:51 Failure

fix(create-mc-app): reverted install-template.mjs, main.yml file and …

ddec1f0

…updated lock file

vercel bot deployed to Preview – merchant-center-application-kit-components-playground July 4, 2024 14:51 View deployment

vercel bot deployed to Preview – mc-app-kit-playground July 4, 2024 14:51 View deployment

kark reviewed Jul 5, 2024

View reviewed changes

packages/create-mc-app/src/validations.ts Outdated Show resolved Hide resolved

.changeset/great-rules-grin.md Outdated Show resolved Hide resolved

style(create-mc-app): added descriptive changeset and removed redunda…

b071639

…nt code Co-authored-by: Kacper Krzywiec <[email protected]>

vercel bot deployed to Preview – merchant-center-application-kit-components-playground July 5, 2024 08:31 View deployment

vercel bot deployed to Preview – mc-app-kit-playground July 5, 2024 08:32 View deployment

style(create-mc-app): linted validations.ts and used dot notation for…

478c731

… CLOUD_IDENTIFIERS

vercel bot deployed to Preview – merchant-center-application-kit-components-playground July 5, 2024 09:13 View deployment

vercel bot deployed to Preview – mc-app-kit-playground July 5, 2024 09:13 View deployment

kark approved these changes Jul 5, 2024

View reviewed changes

.changeset/great-rules-grin.md Show resolved Hide resolved

packages/create-mc-app/src/cli.ts Outdated Show resolved Hide resolved

style(create-mc-app): improved the cloud-identifier documentation

6c34369

vercel bot deployed to Preview – merchant-center-application-kit-components-playground July 5, 2024 10:03 View deployment

vercel bot deployed to Preview – mc-app-kit-playground July 5, 2024 10:04 View deployment

mustafaasif2 marked this pull request as ready for review July 5, 2024 10:49

mustafaasif2 requested a review from a team as a code owner July 5, 2024 10:49

mustafaasif2 requested review from a team and emmenko and removed request for a team July 5, 2024 10:49

gitstream-cm bot added missing-jira and removed missing-jira labels Jul 5, 2024

emmenko approved these changes Jul 9, 2024

View reviewed changes

packages/create-mc-app/src/validations.ts Outdated Show resolved Hide resolved

refactor(create-mc-app): rename cloud identifier validation function …

8bda236

…for clarity

vercel bot deployed to Preview – merchant-center-application-kit-components-playground July 10, 2024 07:39 View deployment

vercel bot deployed to Preview – mc-app-kit-playground July 10, 2024 07:39 View deployment

Rhotimee approved these changes Jul 10, 2024

View reviewed changes

emmenko merged commit 96eb231 into main Jul 10, 2024
20 checks passed

emmenko deleted the SHIELD-1300-add-cloudIdentifier-flag branch July 10, 2024 09:18

ct-changesets bot mentioned this pull request Jul 10, 2024

Version Packages #3566

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(create-mc-app): add cloudIdentifier flag #3564

feat(create-mc-app): add cloudIdentifier flag #3564

mustafaasif2 commented Jul 3, 2024 •

edited by jira bot

Loading

changeset-bot bot commented Jul 3, 2024 •

edited

Loading

vercel bot commented Jul 3, 2024 •

edited

Loading

mustafaasif2 commented Jul 3, 2024 •

edited

Loading

kark left a comment •

edited

Loading

emmenko left a comment

kark left a comment

kark left a comment

emmenko left a comment

Rhotimee left a comment

	const createAppCmdResult = shelljs.exec(
	[
	binaryPath,
	applicationName,
	`--template=${templateName}`,
	`--template-version=${branchName}`,
	`--application-type=${applicationType}`,
	`--initial-project-key=${initialProjectKey}`,
	`--yes`,
	'--skip-install',
	].join(' '),
	{ cwd: sandboxPath }

feat(create-mc-app): add cloudIdentifier flag #3564

feat(create-mc-app): add cloudIdentifier flag #3564

Conversation

mustafaasif2 commented Jul 3, 2024 • edited by jira bot Loading

Summary

Description

Background

changeset-bot bot commented Jul 3, 2024 • edited Loading

🦋 Changeset detected

vercel bot commented Jul 3, 2024 • edited Loading

mustafaasif2 commented Jul 3, 2024 • edited Loading

kark left a comment • edited Loading

Choose a reason for hiding this comment

emmenko left a comment

Choose a reason for hiding this comment

kark left a comment

Choose a reason for hiding this comment

kark left a comment

Choose a reason for hiding this comment

emmenko left a comment

Choose a reason for hiding this comment

Rhotimee left a comment

Choose a reason for hiding this comment

mustafaasif2 commented Jul 3, 2024 •

edited by jira bot

Loading

changeset-bot bot commented Jul 3, 2024 •

edited

Loading

vercel bot commented Jul 3, 2024 •

edited

Loading

mustafaasif2 commented Jul 3, 2024 •

edited

Loading

kark left a comment •

edited

Loading