Changed checkout instructions to use sparse-checkout instead of normal checkout#5797
Changed checkout instructions to use sparse-checkout instead of normal checkout#5797GrantMeStrength merged 1 commit intoMicrosoftDocs:docsfrom
Conversation
…l checkout Referred to Git documentation page on sparse-checkout as not only --cone used to not be default, but init was also not deprecated
|
Learn Build status updates of commit 1108cdc: ✅ Validation status: passed
For more details, please refer to the build report. |
|
@Wallby : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. |
|
@niels9001 do we have a package manager contact to review? |
I pinged @denelon and he has approved the change :)! |
|
@niels9001 Is it stuck? Shouldn't the commit have gone through by now? |
|
@GrantMeStrength can we get this merged? Demitrius signed off on it 😁! |
|
thanks! |
There was a problem hiding this comment.
Pull request overview
Updates the contributor documentation for submitting manifests to the winget-pkgs repository by switching the clone workflow to a sparse-checkout-based approach, aiming to reduce local working set size for submitters.
Changes:
- Replaces
git clonewithgit clone --no-checkoutin the submission instructions. - Adds a new “Setup sparse checkout” step with guidance and an example
git sparse-checkout set ...command. - Adds a “Checkout the repository” step to apply the sparse-checkout settings before making changes.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ### Step 5: Add your manifest to the local repository | ||
|
|
||
| Add your files into the folder explained in step 3. |
There was a problem hiding this comment.
This sentence says to add files into the folder explained in step 3, but step 3 is cloning the repo. The manifest folder structure is described later in this document, so the step reference should be updated (or the folder structure section moved) to avoid sending readers to the wrong place.
| Add your files into the folder explained in step 3. | |
| Add your files into the following folder in your local clone: |
There was a problem hiding this comment.
I think this should have been step 4, not step 3.
| You must add your manifest files to the repository in the following folder structure: | ||
| To initialize sparse checkout for a repository you must type: | ||
|
|
||
| **manifests** / **letter** / **publisher** / **application** / **version** |
There was a problem hiding this comment.
There’s duplicated/overlapping guidance here: the manifest folder structure and PackageIdentifier/PackageVersion path requirements are explained under the sparse-checkout step, and then the folder structure is repeated again in the "Add your manifest" step. Consider keeping the folder-structure rules only in the "Add your manifest" step and referencing them from sparse-checkout, so the sparse-checkout step stays focused and future edits don’t drift.
There was a problem hiding this comment.
Hence the reference to step 4 in (what should have been) step 6.
|
|
||
| Thus to set up sparse checkout for all manifests of a publisher, you'd type: | ||
|
|
||
| 1. If you are using Git version 2.37.0 or newer, run the following command to set up spare checkout for your folder. |
There was a problem hiding this comment.
Typo: "spare checkout" should be "sparse checkout".
|
|
||
| If you are using an older version of Git, refer to the [Git documentation](https://git-scm.com/docs/git-sparse-checkout) for how to set up sparse checkout for your local repository. | ||
|
|
||
| Note that the above command will override all current sparse checkout settings and set it up for only that one folder, refer to the [Git documentation](https://git-scm.com/docs/git-sparse-checkout) for setting up sparce checkout with multiple folders. |
There was a problem hiding this comment.
Typo: "sparce checkout" should be "sparse checkout".
| git checkout | ||
| ``` | ||
|
|
||
| If you are entering multiple submissions, create a branch instead of a fork. We currently allow only one manifest file per submission. |
There was a problem hiding this comment.
There are multiple consecutive spaces in "create a branch". Please reduce to a single space for readability/consistency.
| If you are entering multiple submissions, create a branch instead of a fork. We currently allow only one manifest file per submission. | |
| If you are entering multiple submissions, create a branch instead of a fork. We currently allow only one manifest file per submission. |
| ### Step 5: Checkout the repository | ||
|
|
||
| You can now apply the sparse checkout settings by running. | ||
|
|
||
| ```powershell | ||
| git checkout | ||
| ``` | ||
|
|
||
| If you are entering multiple submissions, create a branch instead of a fork. We currently allow only one manifest file per submission. | ||
|
|
||
| ```powershell | ||
| git checkout -b <branch-name> | ||
| ``` | ||
|
|
||
| ### Step 5: Add your manifest to the local repository | ||
|
|
||
| Add your files into the folder explained in step 3. | ||
| **manifests** / **letter** / **publisher** / **application** / **version** | ||
|
|
||
| ### Step 5: Submit your manifest to the remote repository |
There was a problem hiding this comment.
The heading numbering is inconsistent: "Step 5" is used for three different sections (Checkout, Add your manifest, Submit). This makes the instructions hard to follow and breaks anchor links; renumber these headings (e.g., Step 5/6/7) and ensure any cross-references match.
There was a problem hiding this comment.
That is a typo. Should indeed be 5,6,7
|
@niels9001 Copilot spotted some things I did not catch. Typos. I don't use AI in my editor. And normally work in compiled languages, so I rely on a compiler to check those kinds of things for me. How can these fixes be applied? Or should I do it manually? |
@Wallby Yeah, I think this requires a new PR. We should have reviewed Copilot's comments before merging this |
No description provided.