Proposal: store docs.json in the registry

Offen
#704 21 Kommentare 0 Reaktionen 1 zugewiesene Person Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

@thomashoneyman arbeitet bereits daran.

Seit 27.7.2026.

  • #791 von @thomashoneyman — offen

Bewertung

Dieses Issue wurde noch nicht bewertet.

Beschreibung

pursuit

As part of #525 should we consider storing docs.json in the registry?

  • The registry pipeline is already compiling projects with an appropriate compiler. We can easily add the appropriate codegen targets.
  • The registry pipeline is the sole publisher to Pursuit nowadays. It seems unnecessary to support additional authentication workflows in Pursuit.
  • If we store docs metadata in the registry, pursuit largely becomes a stateless registry client in principle, even though it likely needs to build it's own index.
  • We have more freedom to adjust the actual format (especially wrt metadata) since the registry controls the data end-to-end.

Questions:

  • Where is this actually stored? Package metadata is stored in a single-file ldjson format, but we would want to store version specific files, likely.
  • Are there format changes we need to make? Is there redundant information in the data we currently publish to Pursuit that is otherwise available in the registry?
  • We may need a data migration from pursuit-backups.
  • We may need some additional postback mechanism to notify Pursuit of newly published packages if we don't want to rely on a cron job that pulls the registry metadata.
Vorherrschende Sprache
PureScript
Sterne
95
Forks
79
Ø Merge
16 Std. 13 Min.
Gemergte PRs (30 T.)
14

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus purescript/registry-dev

Alle Issues in purescript/registry-dev

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.