update-nix-fetchgit: A program to update fetchgit values in Nix expressions

[ bsd3, library, nix, program, unclassified ] [ Propose Tags ]

This command-line utility is meant to be used by people maintaining Nix expressions that fetch files from Git repositories. It automates the process of keeping such expressions up-to-date with the latest upstream sources.


[Skip to Readme]
Versions [faq] 0.1.0.0, 0.1.1.0, 0.1.2.0, 0.2.2, 0.2.3, 0.2.4, 0.2.5
Change log CHANGELOG.md
Dependencies aeson (>=0.9), async (>=2.1), base (>=4.13 && <5), bytestring (>=0.10), data-fix, github-rest, hnix (>=0.11), monad-validate, mtl, optparse-applicative, optparse-generic (>=1.4.2), process (>=1.2), regex-tdfa, say, syb, template-haskell, text (>=1.2), time (>=1.5), update-nix-fetchgit, utf8-string (>=1.0), vector [details]
License BSD-3-Clause
Copyright 2020 Joe Hermaszewski
Author Joe Hermaszewski
Maintainer Joe Hermaszewski <haskell@monoid.al>
Category Nix
Home page https://github.com/expipiplus1/update-nix-fetchgit#readme
Bug tracker https://github.com/expipiplus1/update-nix-fetchgit/issues
Source repo head: git clone https://github.com/expipiplus1/update-nix-fetchgit
Uploaded by jophish at 2020-11-14T13:55:30Z
Distributions NixOS:0.1.2.0
Executables update-nix-fetchgit
Downloads 1095 total (312 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs uploaded by user
Build status unknown [no reports yet]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for update-nix-fetchgit-0.2.5

[back to package description]

update-nix-fetchgit

This is a command-line utility for updating fetcher calls in Nix expressions. It has two primary purposes:

  • Automating the process of keeping such expressions up-to-date with the latest sources

  • Filling hashes automatically instead of copying from the error message<sup>1</sup>.

The following fetchers are supported:

  • fetchgit
  • fetchgitPrivate
  • fetchFromGitHub
  • fetchFromGitLab
  • builtins.fetchGit
  • builtins.fetchTarball (Only updates the url when this is a archive fetch from GitHub)
  • pkgs.haskellPackages.callHackageDirect (Only updates the hash)

The options deepClone, leaveDotGit, fetchSubmodules are also supported.

Additionally if the rev (for git fetches) or url attribute has a comment:

  • pin: the revision or URL will not be updated, only the hash will be changed
  • Anything else: the rev or url parameter will be updated to point to the revision pointed to by the branch or tag named in the comment. This is in the format expected by git ls-remote so if the expression has rev = _; # tags/v* it will be updated to the latest tag beginning with v, sorted by version.

Usage

As a command line tool

Pass the name of the files to be updated in place or pass no files to read and write to stdin and stdout (useful as a filter in an editor).

update-nix-fetchgit file1.nix file2.nix

update-nix-fetchgit <file1.nix >file1-updated.nix

It will update fetchers anywhere in the files, note that it is a purely syntactic match so complicated invocations of the fetchers may not be picked up; see ./src/Update/Nix/Updater.hs to look at the shapes of Nix expressions which are matched.

If you pass --only-commented only expressions which have a comment on the rev or url attribute will be updated. This can be useful for updating files en-mass with some control over which expressions are modified with a command like: fd .nix --exec update-nix-fetchgit --only-commented

Please open an issue if update-nix-fetchgit doesn't recognize a fetcher and you think it could.

From Vim

This VimScript will bind <leader>u to update the fetcher under the cursor.

The mnemonic is u for "it's unUsual to update things in this way"

" A helper to preserve the cursor location with filters
function! Preserve(command)
  let w = winsaveview()
  execute a:command
  call winrestview(w)
endfunction

" Update fetcher under cursor, note that this might take a little while if the
" fetched path is large.
autocmd FileType nix map <nowait> <leader>u :call Preserve("%!update-nix-fetchgit --location=" . line(".") . ":" . col("."))<CR>

asciicast

Examples

Here are some examples of nix expressions which can be updated:

  • Updating src and version

    { stdenv, fetchgit }:
    
    stdenv.mkDerivation rec {
      name = "foo-${version}";
      version = "2016-07-13";
      # ^ version will be updated to the date of the new revision
      src = fetchgit {
        url = "git://midipix.org/slibtool";
        rev = "4f56fd184ef6020626492a6f954a486d54f8b7ba";
        # ^ rev will be updated to the revision of HEAD
        sha256 = "0nmyp5yrzl9dbq85wyiimsj9fklb8637a1936nw7zzvlnzkgh28n";
        # ^ sha256 will be updated to the correct hash
      };
    }
    
  • Following a branch fetched with builtins.fetchTarball

    { pkgs ? import (builtins.fetchTarball {
      url =
        "https://github.com/NixOS/nixpkgs/archive/foobar.tar.gz"; # nixos-unstable
        # ^ 'foobar' will be replaced with the revision pointed to by 'refs/heads/nixos-unstable'
      sha256 = "";
      # ^ sha256 will be updated to the correct hash
    }) { } }:
    
    myExpression
    
  • Updating the hash (instead of trying to build and copying the hash from the error message)

    {
      upfind = import (pkgs.fetchFromGitHub {
        owner = "expipiplus1";
        repo = "upfind";
        rev = "cb451254f5b112f839aa36e5b6fd83b60cf9b9ae"; # pin
        # ^ This will not change because of the '# pin' comment
        sha256 = _;
        # ^ This will be updated
      }) { };
    }
    

Mechanism

When you run update-nix-fetchgit on a file, it will:

  • Read the file and parse it as a Nix expression.
  • Find all calls to fetchers.
  • Run nix-prefetch-git or nix-prefetch-url (and a call to the GitHub API to get the commit date in the case of builtins.fetchTarball) to get information about the latest version.
  • Update the corresponding rev, sha256, url, and version attributes for each repository.
  • Overwrite the original input file or print to stdout

Any version attribute found in the file will be updated if it is in a set that contains (directly or indirectly) a Git fetch. The version attribute will be updated to the commit date of the latest HEAD commit in the Git repository, in the time zone of the committer, in "YYYY-MM-DD" format. If the set contains multiple Git fetches, the latest such date is used.

Building from source

The recommended way to build this program from source for development purposes is to download and run nix-shell in the top-level source directory and then run cabal build.

Authors


<a name="deny">1</a>: Don't deny you do it