Fehlende Rückmeldung bezüglich publiccode.yml Verarbeitung

Hallo zusammen!

Ich hatte schon mehrfach das Problem, dass Änderungen an der publiccode.yml (die laut Editor gültig ist), nicht im Softwareverzeichnis gelandet sind.
Es wäre hilfreich, wenn OpenCoDe Rückmeldung zum Verarbeitungsstatus (wann wurde eine Änderung erkannt, wurde die Änderung erfolgreich verarbeitet) der publiccode.yml geben würde und dabei auftretende Fehler beispielsweise automatisch als Issues im jeweiligen Projekt anlegt.

Man könnte auch die Komponenten, die für diese Verarbeitung zuständig sind, auf der Status-Seite aufführen, sodass man nachvollziehen kann, ob vielleicht einfach nur die entsprechende Komponente aktuell nicht läuft.

Viele Grüße,
Steffen

1 „Gefällt mir“

Hallo Steffen,
vielen Dank für den Hinweis! Das habe ich intern weitergegeben.

Gibt es hier etwas Neues? Ich habe jetzt wieder das Problem, dass ein Update der publiccode.yml keine Auswirkung auf den Inhalt im Softwareverzeichnis hat.

Hey, leider nicht. Es gibt aber inzwischen eine Anleitung für die Erstellung der publiccode.yml-Datei inkl. eine kommentierte Datei, wo drin steht, welche Felder auf der Projektdetailseite im Softwareverzeichnis sichtbar sind; Aufnahme in das Softwareverzeichnis - openCode-Guide. Es werden nämlich nicht allen möglichen Felder aus der publiccode.yml auf der Projektdetailseite dargestellt. Um welches Feld handelt es sich denn bei dir bzw. was wird nicht im Softwareverzeichnis angezeigt?

Es geht schon um sichtbare Attribute, wie Titel, Kurzbeschreibung oder auch Logo. Die publiccode.yml ist auch gültig und wurde nur inhaltlich geändert.

Im konkreten Fall ging es um die Kurzbeschreibung, in der im Anführungszeichen benutzt wurden, die aber scheinbar nicht in der Form im Softwareverzeichnis unterstützt werden und kodiert („"“) erschienen sind. Die Commits zum Ändern dieses Felds haben zu keinen Änderungen im Verzeichnis geführt. Mittlerweile stimmt der Eintrag wieder mit der publiccode.yml überein, ohne dass nachvollziehbar ist, was dies wann ausgelöst hat.

Der angegebene Link funktioniert leider nicht.

Hallo Steffen,

deine publiccode.yml-Datei sieht ja soweit ganz gut aus. Du kannst in der Kurzbeschreibung auch Anführungszeichen nutzen, diese musst du dann allerdings mit einem Backslash maskieren. Die genauen syntaktischen Möglichkeiten kannst du in diesem Stackoverflow-Post nachlesen: syntax - How do I break a string in YAML over multiple lines? - Stack Overflow

Gibt es ansonsten noch Felder, die du im Softwareverzeichnis vermisst?

Ich gebe mal weiter, dass wir überlegen, wie genau wir mit Darstellungsfehlern in der publiccode.yml-Datei umgehen. Es kann ja schon Sinn machen die auch den Nutzenden weiterzuleiten.

Liebe Grüße
Niklas Köhler (Community & Support openCode)

Hallo Niklas,

danke, das Escapen habe ich dann nicht noch versucht.
Syntaktisch stimmen die publiccode.yml-Dateien wie von einem Linter und dem Editor bestätigt, trotzdem werden die Daten einfach nicht immer aktualisiert.
Gerade eben wieder das Beispiel:
Das Projekt LandWohl im Softwareverzeichnis hat aus dem neusten Commit nur die Versionsnummer aktualisiert. Das angepasste Datum oder der korrekte Titel (LandWohl statt Landwohl) wurden nicht übernommen.
Für mich erschließt sich nicht, nach welcher Logik Felder geparst/aktualisert werden, deswegen wäre das Feedback, wann/ob der Parser durchgelaufen ist und was der Parser getan hat, so wichtig.
Sind die beteiligten Komponenten (Softwareverzeichnis und Parser) eigentlich auch irgendwo Open Source gestellt? Wäre ja eigentlich im Sinne des Projektes.