Create a windows_dev.md document for buildkit developers on Windows

[danielGithinji]

This PR adds a windows_dev.md file to the docs folder. This file contains documentation to help buildkit developers navigate the development of buildkit on Windows. This 1st version adds documentation on how to run integration tests.

[profnandaa]

Just those last comments and LGTM.

[profnandaa]

Please squash the commits into one.

[profnandaa]

/cc. @crazy-max

[castrombithisamm]

I am following these steps to setup on my local machine, and there is a place where you said, "Remove any other buildkit binary available in $env:PATH". When I cd $env:GOPATH\bin and dir into $env:GOPATH\bin directory, I get some files there:

- -a----         10/1/2024   5:23 PM       28587520 buildctl.exe
- -a----         10/1/2024   5:23 PM       56246272 buildkitd.exe
- -a----         5/14/2024   5:31 PM       19312128 dlv.exe
- -a----         4/19/2024   8:30 AM       31768576 gopls.exe
- -a----         9/30/2024   4:30 PM       52032512 registry.exe
- -a----         4/19/2024   8:32 AM       13856256 staticcheck.exe

my question is which ones should I remove?

[danielGithinji]

Hi @castrombithisamm . The files you should remove or rename is both buildkitctl.exe and buildkitd.exe

[castrombithisamm]

Hi @danielGithinji thank you for getting back, so that means I should delete them from the $env:GOPATH\bin directory, and only be left with these? Then after that, I can run the test. right?

- -a----         5/14/2024   5:31 PM       19312128 dlv.exe
- -a----         4/19/2024   8:30 AM       31768576 gopls.exe
- -a----         9/30/2024   4:30 PM       52032512 registry.exe
- -a----         4/19/2024   8:32 AM       13856256 staticcheck.exe

[danielGithinji]

@castrombithisamm, when you install buildkit for the 1st time (using these instructions) its found in $env:PATH. It appears there just like any other binary you've installed in your machine.

$env:GOPATH\bin - stores binaries of go projects that you've installed from your local machine. This means that when you git clone the buildkit source code, and install it, its going to be available in $env:GOPATH\bin .

When running buildkit and in order for there to be no conflicts between the buildkit binary in your PATH i.e $env:PATH, and the one installed in $env:GOPATH\bin, you need to remove or rename the binary in your PATH. (The binary here includes both buildctl.exe and buildkitd.exe)

[castrombithisamm]

I hear you @danielGithinji and thanks for clarifying this. I forgot to mention that my PATH $env:PATH doesn't have any buildkit binary files installed. The ones shown here were installed in $env:GOPATH\bin

PS C:\Users\awond\buildkit> cd "$env:GOPATH\bin"
PS C:\Users\awond\go\bin> dir
    Directory: C:\Users\awond\go\bin
Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a----         10/1/2024   5:23 PM       28587520 buildctl.exe
-a----         10/1/2024   5:23 PM       56246272 buildkitd.exe
-a----         5/14/2024   5:31 PM       19312128 dlv.exe
-a----         4/19/2024   8:30 AM       31768576 gopls.exe
-a----         9/30/2024   4:30 PM       52032512 registry.exe
-a----         4/19/2024   8:32 AM       13856256 staticcheck.exe

Maybe it would have been easier to understand if we listed all locations where the buildkit binary is available using Get-Command buildkitd Like in my case here when I checked using the command it gave me this:

PS C:\Users\awond\buildkit> Get-Command buildkitd
CommandType     Name                                               Version    Source
-----------     ----                                               -------    ------
Application     buildkitd.exe                                      0.0.0.0    C:\Users\awond\go\bin\buildkitd.exe

I don't know if I am correct, but this means my buildkit binary is installed in $env:GOPATH\bin .

To conclude maybe we can say that we need to make sure that Get-Command buildkitd returns an equivalent of $env:GOPATH\bin\buildkit.exe for the Source field. If not, delete any other buildkitd being returned or remove them from $env:PATH

[danielGithinji]

@castrombithisamm - I have updated the document based on your sentiments so that it becomes clear how someone would need to proceed in this specific scenario.

[castrombithisamm]

@danielGithinji many thanks for incorporating my sentiments into the document

[profnandaa]

@crazy-max -- can take a look at this?

[crazy-max]

I don't think this is necessary, you can just run:

docker buildx bake binaries-for-test --set *.platform=windows/amd64

To output dev binaries:

$ tree -nh ./bin/build
[4.0K]  ./bin/build
├── [ 29M]  buildctl.exe
├── [ 56M]  buildkitd.exe
├── [ 17M]  containerd-shim-runhcs-v1.exe
├── [ 37M]  containerd.exe
├── [2.2M]  gocovmerge.exe
├── [7.5M]  gotestsum.exe
├── [ 573]  gotestsumandcover
└── [ 23M]  registry.exe

0 directories, 8 files

Will open a PR to also include delve

So just cloning repo, installing go and command above should be enough to get started.

[crazy-max]

Does not seem related to this PR, can you open a new one for this fix?

[danielGithinji]

I've removed it. I'll open a new one to fix it.

[crazy-max]

Same as https://github.com/moby/buildkit/pull/5291/files#r1832519755