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

[Functions] Bump @shopify/function_javascript to v 1.0.0 #4448

Merged
merged 1 commit into from
Sep 13, 2024

Conversation

saulecabrera
Copy link
Member

@saulecabrera saulecabrera commented Sep 13, 2024

This commit ensures that new functions are bootstrapped with version 1.0.0 of the @shopify/function_javascript package, which includes the
changes in Shopify/shopify-function-javascript#16

Note that the javy npm dependency is no longer required as per Shopify/shopify-function-javascript#16

How to test your changes?

To 🎩

Post-release steps

Measuring impact

How do we know this change was effective? Please choose one:

  • n/a - this doesn't need measurement, e.g. a linting rule or a bug-fix
  • Existing analytics will cater for this addition
  • PR includes analytics changes to measure impact

Checklist

  • I've considered possible cross-platform impacts (Mac, Linux, Windows)
  • I've considered possible documentation changes

This commit ensures that new functions are bootstrapped with version
1.0.0 of the `@shopify/function_javascript` package, which includes the
  changes in Shopify/shopify-function-javascript#16

To 🎩

* Create a new app and JavaScript extension.
* Build the app
* Run the app
Copy link
Contributor

We detected some changes at either packages/*/src or packages/cli-kit/assets/cli-ruby/** and there are no updates in the .changeset.
If the changes are user-facing, run "pnpm changeset add" to track your changes and include them in the next release CHANGELOG.

Copy link
Contributor

Differences in type declarations

We detected differences in the type declarations generated by Typescript for this branch compared to the baseline ('main' branch). Please, review them to ensure they are backward-compatible. Here are some important things to keep in mind:

  • Some seemingly private modules might be re-exported through public modules.
  • If the branch is behind main you might see odd diffs, rebase main into this branch.

New type declarations

We found no new type declarations in this PR

Existing type declarations

packages/cli-kit/dist/public/common/retry.d.ts
@@ -10,7 +10,6 @@
  * @param performAction - The action to perform.
  * @param recoveryProcedure - The recovery procedure to perform if the action
  * fails the first time.
- * @param retries - The number of times to retry the action if an error happens.
  * @returns The result of the action.
  */
-export declare function performActionWithRetryAfterRecovery<T>(performAction: () => Promise<T>, recoveryProcedure: () => Promise<unknown>, retries?: number): Promise<T>;
\ No newline at end of file
+export declare function performActionWithRetryAfterRecovery<T>(performAction: () => Promise<T>, recoveryProcedure: () => Promise<unknown>): Promise<T>;
\ No newline at end of file

Copy link
Contributor

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements
72.86% (+0.11% 🔼)
8307/11402
🟡 Branches
69.42% (+0.05% 🔼)
4055/5841
🟡 Functions
71.67% (+0.03% 🔼)
2165/3021
🟡 Lines
73.2% (+0.11% 🔼)
7858/10735

Test suite run success

1868 tests passing in 849 suites.

Report generated by 🧪jest coverage report action from 002f756

@saulecabrera
Copy link
Member Author

/snapit

Copy link
Contributor

🫰✨ Thanks @saulecabrera! Your snapshot has been published to npm.

Test the snapshot by intalling your package globally:

pnpm i -g @shopify/[email protected]

After installing, validate the version by running just shopify in your terminal
If the versions don't match, you might have multiple global instances installed.
Use which shopify to find out which one you are running and uninstall it.

@andrewhassan
Copy link
Contributor

Code LGTM!

🎩:

  • Generated a JS function in an existing app and built it
  • Generated a JS function in a new app and built it

@saulecabrera saulecabrera added this pull request to the merge queue Sep 13, 2024
Merged via the queue into main with commit 7b02d48 Sep 13, 2024
@saulecabrera saulecabrera deleted the update-shopify-func-js-package branch September 13, 2024 18:29
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