invidious: document update process

This commit is contained in:
schnusch 2022-03-13 11:35:06 +01:00
parent a4811f1fa3
commit 30bbba0e1f

View file

@ -1,13 +1,17 @@
{ lib, crystal, fetchFromGitHub, librsvg, pkg-config, libxml2, openssl, shards, sqlite, lsquic, videojs, nixosTests }: { lib, crystal, fetchFromGitHub, librsvg, pkg-config, libxml2, openssl, shards, sqlite, lsquic, videojs, nixosTests }:
let let
# When updating, always update the following: # All versions, revisions, and checksums are stored in ./versions.json.
# * the git revision # The update process is the following:
# * the version attribute # * pick the latest commit
# * the source hash (sha256) # * update .invidious.rev, .invidious.version, and .invidious.sha256
# If the shards.lock file changed, also the following: # * prefetch the videojs dependencies with scripts/fetch-player-dependencies.cr
# * shards.nix (by running `crystal2nix` in invidious source tree) # and update .videojs.sha256 (they are normally fetched during build
# * If the lsquic.cr dependency changed: lsquic in lsquic.nix (version, sha256) # but nix's sandboxing does not allow that)
# * If the lsquic version changed: boringssl' in lsquic.nix (version, sha256) # * if shard.lock changed
# * recreate shards.nix by running crystal2nix
# * update lsquic and boringssl if necessarry, lsquic.cr depends on
# the same version of lsquic and lsquic requires the boringssl
# commit mentioned in its README
versions = builtins.fromJSON (builtins.readFile ./versions.json); versions = builtins.fromJSON (builtins.readFile ./versions.json);
in in
crystal.buildCrystalPackage rec { crystal.buildCrystalPackage rec {