Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,8 +157,9 @@ Version source -- how do we track upstream version updates?
- `src.openvsx = publisher.ext_name` -- the latest version of a vscode extension from open vsx
- `src.vsmarketplace = publisher.ext_name` -- the latest version of a vscode extension from vscode marketplace
- `src.cmd = cmd` -- the version from a shell command (e.g. `echo Meow`)
= `src.container = owner/name` - the latest tag of a container from the Docker registry

Optional list options for some version sources (`src.github_tag`, `src.webpage`, and `src.httpheader`),
Optional list options for some version sources (`src.github_tag`, `src.webpage`, and `src.httpheader` and `src.container`),
see the corresponding [nvchecker documentation](https://nvchecker.readthedocs.io/en/latest/usage.html#list-options) for details.

- `src.include_regex`
Expand All @@ -185,6 +186,7 @@ How do we fetch the package source if we have the target version number?
- `fetch.openvsx = publisher.ext_name`
- `fetch.vsmarketplace = publisher.ext_name`
- `fetch.tarball = tarball_url`
- `fetch.docker = owner/name`

Optional `nix-prefetch fetchgit` config, which make sense only when the fetcher equals to `fetch.github` or `fetch.git`.
They can exist simultaneously.
Expand All @@ -193,6 +195,14 @@ They can exist simultaneously.
- `git.fetchSubmodules`
- `git.leaveDotGit`

Optional config for `fetch.docker`/`dockerTools.pullImage`:

- `docker.os`
- `docker.arch`
- `docker.finalImageName`
- `docker.finalImageTag`
- `docker.tlsVerify`

#### Extract src

Optional _extract src_ config, files are extracted into build directory, and then read by `readFile` in generated nix expr.
Expand Down
5 changes: 5 additions & 0 deletions nvfetcher_example.toml
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,8 @@ fetch.github = "lilydjwg/nvchecker"
[nixpkgs]
src.git = "https://github.com/NixOS/nixpkgs"
fetch.tarball = "https://github.com/nixos/nixpkgs/archive/$ver.tar.gz"

[alpine]
src.container = "library/alpine"
src.include_regex = "3\\..*"
fetch.docker = "library/alpine"