libretro: improve update_cores.py script

- Add support for multiple fetchers (for now `fetchFromGitHub` is still
  the only supported one)
- Use `--meta` from `nix-prefetch-github` to extract the date
- Show errors in `nix-prefetch-github` if they occur
This commit is contained in:
Thiago Kenji Okada 2024-02-10 15:41:53 +00:00
parent f9d40ef7bc
commit e5c0985730
2 changed files with 35 additions and 49 deletions

View file

@ -48,13 +48,15 @@ let
getCore = repo: (lib.getAttr repo hashesFile);
getCoreSrc = repo:
(lib.pipe repo [
getCore
(x: builtins.removeAttrs x [ "date" ])
fetchFromGitHub
]);
let
inherit (getCore repo) src fetcher;
fetcherFn = {
inherit fetchFromGitHub;
}.${fetcher} or (throw "Unknown fetcher: ${fetcher}");
in
fetcherFn src;
getCoreDate = repo: (getCore repo).date or "unstable-1970-01-01";
getCoreVersion = repo: (getCore repo).version;
mkLibretroCore =
# Sometimes core name != repo name, so you may need to set them differently
@ -67,7 +69,7 @@ let
{ core
, repo ? core
, src ? (getCoreSrc repo)
, version ? (getCoreDate repo)
, version ? (getCoreVersion repo)
, ...
}@args:
import ./mkLibretroCore.nix ({

View file

@ -1,5 +1,5 @@
#!/usr/bin/env nix-shell
#!nix-shell -I nixpkgs=./ -i python3 -p "python3.withPackages (ps: with ps; [ requests ])" -p git -p nix-prefetch-github
#!nix-shell -I nixpkgs=./ -i python3 -p "python3.withPackages (ps: with ps; [ ])" -p git -p nix-prefetch-github -p nix-prefetch-scripts
import json
import os
@ -8,8 +8,6 @@ import sys
from concurrent.futures import ThreadPoolExecutor
from pathlib import Path
import requests
SCRIPT_PATH = Path(__file__).absolute().parent
HASHES_PATH = SCRIPT_PATH / "hashes.json"
GET_REPO_THREADS = int(os.environ.get("GET_REPO_THREADS", 8))
@ -19,10 +17,13 @@ GET_REPO_THREADS = int(os.environ.get("GET_REPO_THREADS", 8))
# You may set `deep_clone`, `fetch_submodules` or `leave_dot_git` options to
# `True` and they're similar to `fetchgit` options. Also if for some reason you
# need to pin a specific revision, set `rev` to a commit.
# To generate the hash file for your new core, you can run `update_cores.py
# <core>`. The script needs to be run from the root of your `nixpkgs` clone.
# Do not forget to add your core to `cores.nix` file with the proper overrides
# so the core can be build.
# There is also a `fetcher` option that for now only supports `fetchFromGitHub`
# (see `get_repo_hash()`), but it may be extended in the future if there is a
# need to support fetchers from other source hubs.
# To generate the hash file for your new core, you can run
# `<nixpkgs>/pkgs/applications/emulators/retroarch/update_cores.py <core>`. Do
# not forget to add your core to `cores.nix` file with the proper overrides so
# the core can be build.
CORES = {
"2048": {"repo": "libretro-2048"},
"atari800": {"repo": "libretro-atari800"},
@ -128,30 +129,6 @@ def info(*msg):
print(*msg, file=sys.stderr)
def get_rev_date_fetchFromGitHub(repo, owner, rev):
# https://docs.github.com/en/rest/commits/commits?apiVersion=2022-11-28#get-a-commit
url = f"https://api.github.com/repos/{owner}/{repo}/commits/{rev}"
headers = {
"Accept": "application/vnd.github+json",
"X-GitHub-Api-Version": "2022-11-28",
}
if token := os.environ.get("GITHUB_TOKEN"):
headers["Authorization"] = f"Bearer {token}"
r = requests.get(url, headers=headers)
try:
j = r.json()
except requests.exceptions.JSONDecodeError:
return None
date = j.get("commit", {}).get("committer", {}).get("date")
if date:
# Date format returned by API: 2023-01-30T06:29:13Z
return f"unstable-{date[:10]}"
else:
return None
def get_repo_hash_fetchFromGitHub(
repo,
owner="libretro",
@ -176,18 +153,24 @@ def get_repo_hash_fetchFromGitHub(
if rev:
extra_args.append("--rev")
extra_args.append(rev)
result = subprocess.run(
["nix-prefetch-github", owner, repo, *extra_args],
check=True,
capture_output=True,
text=True,
)
try:
result = subprocess.run(
["nix-prefetch-github", owner, repo, "--meta", *extra_args],
check=True,
capture_output=True,
text=True,
)
except subprocess.CalledProcessError as ex:
info(f"Error while updating {owner}/{repo}:", ex.stderr)
raise ex
j = json.loads(result.stdout)
date = get_rev_date_fetchFromGitHub(repo, owner, j["rev"])
if date:
j["date"] = date
# Remove False values
return {k: v for k, v in j.items() if v}
return {
"fetcher": "fetchFromGitHub",
# Remove False values
"src": {k: v for k, v in j["src"].items() if v},
"version": f"unstable-{j['meta']['commitDate']}",
}
def get_repo_hash(fetcher="fetchFromGitHub", **kwargs):
@ -229,6 +212,7 @@ def main():
cores = {core: repo for core, repo in CORES.items() if core in cores_to_update}
repo_hashes = get_repo_hashes(cores)
repo_hashes["!comment"] = "Generated with update_cores.py script, do not edit!"
info(f"Generating '{HASHES_PATH}'...")
with open(HASHES_PATH, "w") as f:
f.write(json.dumps(dict(sorted(repo_hashes.items())), indent=4))