Skip to content

Conversation

@karreiro
Copy link
Contributor

WHY are these changes introduced?

This PR moves the addToGitIgnore to cli-kit, following the suggestion in this thread #5184 (comment)

WHAT is this pull request doing?

This PR moves the addToGitIgnore from the theme package to cli-kit, following the suggestion in the thread above.

How to test your changes?

  • Run shopify theme metafields pull
  • Notice that, when the .shopify/metafields.json file is created, .shopify is also added in the gitignore

Post-release steps

N/A

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

@karreiro karreiro requested review from a team as code owners January 21, 2025 09:43
@github-actions
Copy link
Contributor

github-actions bot commented Jan 21, 2025

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements
75.36% (+0.04% 🔼)
8902/11812
🟡 Branches
70.59% (+0.03% 🔼)
4328/6131
🟡 Functions
75.14% (+0.05% 🔼)
2340/3114
🟡 Lines
75.9% (+0.05% 🔼)
8413/11084
Show files with reduced coverage 🔻
St.
File Statements Branches Functions Lines
🟢
... / app-event-watcher.ts
93.83% (-1.23% 🔻)
86.49% (-2.7% 🔻)
90.48% 98.61%

Test suite run success

2005 tests passing in 905 suites.

Report generated by 🧪jest coverage report action from ab407f3

Copy link
Contributor

@frandiox frandiox left a comment

Choose a reason for hiding this comment

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

Thank you!!

@karreiro karreiro force-pushed the mv-git-ignore-cli-kit branch 4 times, most recently from 28635d5 to 6f3e0fb Compare January 23, 2025 11:41
@karreiro karreiro force-pushed the mv-git-ignore-cli-kit branch from 6f3e0fb to ab407f3 Compare January 23, 2025 12:10
@github-actions
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/node/git.d.ts
@@ -27,6 +27,16 @@ export interface GitIgnoreTemplate {
  * @param template - The template to use to create the .gitignore file.
  */
 export declare function createGitIgnore(directory: string, template: GitIgnoreTemplate): void;
+/**
+ * Add an entry to an existing .gitignore file.
+ *
+ * If the .gitignore file doesn't exist, or if the entry is already present,
+ * no changes will be made.
+ *
+ * @param root - The directory containing the .gitignore file.
+ * @param entry - The entry to add to the .gitignore file.
+ */
+export declare function addToGitIgnore(root: string, entry: string): void;
 /**
  * Options to use when cloning a git repository.
  *

@karreiro karreiro added this pull request to the merge queue Jan 24, 2025
Merged via the queue into main with commit cad370d Jan 24, 2025
@karreiro karreiro deleted the mv-git-ignore-cli-kit branch January 24, 2025 07:46
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.

4 participants