mdebray/tvl-depot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
tvl-depot/views/README.md

31 lines
1 KiB
Markdown
Raw Normal View History

feat(kit): Export TVL kit as a josh workspace This creates a josh workspace called `views/kit` which exports all dependencies needed by external users of the TVL kit. The intention of this is to have a single clonable "virtual repo" which provides everything needed to run a system like TVL, but without the projects that we develop *in* TVL. Right now this is limited to the basic Nix code (readTree, pipeline generation) and things required for Gerrit integration. The workspace maps depot paths into slightly different (simpler) locations inside the exported view, to avoid a nested, mostly empty structure. Note: This is not an "external API" or some such of depot, it is simply a convenience for exporting some of our tooling. Change-Id: Ied24aaef117fc2e0c188ec742ae7cd993a5babd3 Reviewed-on: https://cl.tvl.fyi/c/depot/+/4991 Tested-by: BuildkiteCI Reviewed-by: sterni <sternenseemann@systemli.org>
2022-01-18 16:33:05 +01:00
depot views
===========
This folder contains external views of depot content, defined using
josh workspaces. See the individual views for a description of their
docs(views): extend README for josh-filter usage Also document how these can be cloned by referring to a custom Gerrit ref. Change-Id: I5495a1c29bdd6d78215af7307953437f9cbca5db Reviewed-on: https://cl.tvl.fyi/c/depot/+/8198 Tested-by: BuildkiteCI Reviewed-by: tazjin <tazjin@tvl.su>
2023-03-03 15:17:16 +01:00
individual content and usage information.
Testing changes locally
-----------------------
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 22:18:10 +02:00
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:
docs(views): extend README for josh-filter usage Also document how these can be cloned by referring to a custom Gerrit ref. Change-Id: I5495a1c29bdd6d78215af7307953437f9cbca5db Reviewed-on: https://cl.tvl.fyi/c/depot/+/8198 Tested-by: BuildkiteCI Reviewed-by: tazjin <tazjin@tvl.su>
2023-03-03 15:17:16 +01:00
- Commit your changes. This is required, as `josh-filter` operates on your
`HEAD`, not working directory state.
- Invoke `josh-filter` with the filter expression,
fix(views/kit): communicate :unsign in the tvl-kit URL directly Instead of prepending :unsign to all URLs in josh-proxy, and for all calls to filteredGitPush, explicitly use it only in the filter we use for the `export-kit` extraStep. This means, people cloning tvl-kit via > https://code.tvl.fyi/depot.git:workspace=views/kit.git now need to update the URL to point to > https://code.tvl.fyi/depot.git:unsign:workspace=views/kit.git instead. git@github.com:tvlfyi/kit.git will keep the same hashes, as it's updated to export the unsigned workspace view of it. This is less invasive than dooming every josh workspace to have to strip signatures. Change-Id: I6de05182fad4c3695081388c3bbf37306521d255 Reviewed-on: https://cl.tvl.fyi/c/depot/+/8369 Autosubmit: flokli <flokli@flokli.de> Reviewed-by: tazjin <tazjin@tvl.su> Tested-by: BuildkiteCI
2023-03-30 16:30:22 +02:00
for example `josh-filter ':workspace=views/tvix'`.
docs(views): extend README for josh-filter usage Also document how these can be cloned by referring to a custom Gerrit ref. Change-Id: I5495a1c29bdd6d78215af7307953437f9cbca5db Reviewed-on: https://cl.tvl.fyi/c/depot/+/8198 Tested-by: BuildkiteCI Reviewed-by: tazjin <tazjin@tvl.su>
2023-03-03 15:17:16 +01:00
- 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
````
Reference in a new issue Copy permalink