Skip to content

Commit

Permalink
Add note about sharing between WSL / windows (#6003)
Browse files Browse the repository at this point in the history
* add note about sharing between WSL / windows
  • Loading branch information
scbedd authored Apr 19, 2023
1 parent 92f5d5f commit 7fba2fd
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion tools/test-proxy/documentation/asset-sync/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,10 @@ Interactions with the external assets repository are accessible when the proxy i

Each of these CLI Commands takes an `assets.json` argument that provides the _context_ that should be pushed to the external repository.

### A note about using on Windows + WSL

When using a Windows machine, it is technically possible to invoke tests from WSL against a windows clone. That path would appear under `/mnt/c/path/to/your/repo`. This is _not_ a supported scenario, as the `test-proxy` shells out to git for the push/restore actions. Running a `git push/pull` from _linux_ against a repo that was cloned down using a _windows_ git client can have unexpected results. Better to avoid the situation entirely and use an entirely separate clone for work on WSL.

## test-proxy CLI commands

The test-proxy also offers interactions with the external assets repository as a CLI. Invoking `test-proxy --help` will show the available list of commands. `test-proxy <command> --help` will show the help and options for an individual command. The options for a given command are all `--<option>`, for example, `--assets-json-path`, but each option has an abbreviation shown in the help, those are a single dash. For example the abbreviation for `--assets-json-path` is `-a`.
Expand Down Expand Up @@ -157,7 +161,6 @@ Use [the transition script](https://github.com/Azure/azure-sdk-tools/blob/main/e

In summary, once an assets.json is present, the shim _must_ be updated to **actually send** a reference to that assets.json inside the `record/start` or `playback/start` requests!


![assets diagram](../_images/before_after.png)

### What does this look like in practice?
Expand Down

0 comments on commit 7fba2fd

Please sign in to comment.