about summary refs log tree commit diff
path: root/views/README.md
blob: a6ebd93a77882bc4d74580f1a2b815c142a3aee9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
depot views
===========

This folder contains external views of depot content, defined using
josh workspaces. See the individual views for a description of their
individual content and usage information.

Testing changes locally
-----------------------

Generally, when iterating on these files, it's best to locally invoke `josh-
filter` (from `//third_party//josh`) locally to inspect how the workspace would
look like:

  - Commit your changes. This is required, as `josh-filter` operates on your
    `HEAD`, not working directory state.
  - Invoke `josh-filter` with the filter expression,
    for example `josh-filter ':workspace=views/tvix'`.
  - Peek at the synthesized git history by looking at `FILTERED_HEAD`.

Testing changes in Gerrit
-------------------------

It's also possible to clone resulting workspaces for CLs that were already
pushed to Gerrit, but didn't land in master yet.

For CL1234 at revision 2, the URL passed to `git clone` would look like this:

```
https://code.tvl.fyi/depot.git@refs/changes/32/1234/2:workspace=views/kit.git
````