tvl-depot/views/README.md
Florian Klink 98863e7312 docs(views): update where josh-filter is coming from
We started using josh from nixpkgs since cl/11457, but forgot to update
this documentation.

Change-Id: I6e07227bcd3e955076d46146024edd89b69f08f7
Reviewed-on: https://cl.tvl.fyi/c/depot/+/12244
Autosubmit: flokli <flokli@flokli.de>
Reviewed-by: Ilan Joselevich <personal@ilanjoselevich.com>
Tested-by: BuildkiteCI
2024-08-18 20:44:39 +00:00

30 lines
1 KiB
Markdown

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 invoke `josh-filter`
(from the `josh` package) 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
````