[Git][reproducible-builds/reproducible-notes][master] cross-distro: add update and feedback on proposal

[Santiago Torres-Arias]

Santiago Torres-Arias pushed to branch master at Reproducible Builds / reproducible-notes


Commits:
43f5eaee by Santiago Torres at 2018-11-25T22:32:41Z
cross-distro: add update and feedback on proposal

- - - - -


2 changed files:

- + er.gv
- ideas_on_sharing_notes_between_distros


Changes:

=====================================
er.gv
=====================================
@@ -0,0 +1,47 @@
+digraph {
+    graph [pad="0.5", nodesep="0.5", ranksep="2"];
+    node [shape=plain]
+    rankdir=LR;
+
+
+Issues [label=<
+<table border="0" cellborder="1" cellspacing="0">
+  <tr><td><i>Issues</i></td></tr>
+  <tr><td port="url">url</td></tr>
+  <tr><td >description</td></tr>
+  <tr><td port="distro_issue">distro</td></tr>
+</table>>];
+
+
+Package [label=<
+<table border="0" cellborder="1" cellspacing="0">
+  <tr><td><i>Package</i></td></tr>
+  <tr><td port="issues">issues</td></tr>
+  <tr><td>comments</td></tr>
+  <tr><td>bugs</td></tr>
+  <tr><td port="distros">distros</td></tr>
+</table>>];
+
+
+Distro_issue[label=<
+<table border="0" cellborder="1" cellspacing="0">
+  <tr><td><i>Distro Issue</i></td></tr>
+  <tr><td port="comment">comment</td></tr>
+  <tr><td port="state">state</td></tr>
+</table>>];
+
+Distro_package[label=<
+<table border="0" cellborder="1" cellspacing="0">
+  <tr><td><i>Distro Package</i></td></tr>
+  <tr><td port="comment">comment</td></tr>
+  <tr><td port="bugs">bugs</td></tr>
+  <tr><td port="issues">issues</td></tr>
+  <tr><td port="version">version</td></tr>
+</table>>];
+
+
+Distro_issue -> Issues:distro_issue [arrowhead="crow"];
+Distro_package:issues -> Distro_issue [arrowhead="crow"];
+Package:issues -> Issues [arrowhead="crow"];
+Package:distros -> Distro_package [arrowhead="crow"];
+}


=====================================
ideas_on_sharing_notes_between_distros
=====================================
@@ -56,3 +56,71 @@ package:
   issues: []
 
 
+Before the reproducible builds summit in Paris
+
+## Migration plans
+
+- Which upstream tools would require to be updated to the new schema?
+- Should we mass-migrate to a temporary namespace? (e.g.,
+  v2.{notes,packages}.yml or such) and flip the switch at a pre-defined date?
+- Provide a mass migration tool (i.e., take the version 1 and update the schema
+  with same defaults, are all of the notes debian here?)
+
+
+## Review of the current solution 
+
+Comparing against the requirements listed above:
+
++ we need a format where we can separate "upstream" issues, distro-specific
+  issues, distro-specific versions, etc:
+  - A keyword "upstream" inside of the distro list may be useful to track
+    issues upstream
+
++ different distros might have different way to fix issues:
+  - Likewise, should we add a way to flag as duplicate between distros?
+
+
+## Elaborating on the fields proposed
+
+an inline copy of the current schema with "comments" is embedded so as to
+describe what exactly would each field entail.
+
+issue: 
+  url:          # a url/id of this issue
+  description:  # a human-readable description of such issue
+  distro:       # a list of distro-specific objects, keyed by distro name (e.g., debian, arch, freebsd)
+    debian:     
+      state: fixed # state: open/fixed/unknown
+      comment:     # 
+
+package:
+  distros:      # a list of distro-specific objects, keyed by distro name (e.g., debian, arch, freebsd)
+    debian:
+      issues:   # issue pointers that match the id under issues.yml
+        - issue1
+        - issue2 / free text            #   ← fixed issue
+      comments: # human-readable string containing any information that's distro-specific
+      bugs: []  # a list of urls to bugs/issues opened regarding this package in the distro-bugtracker
+      version:  # version that's affected by this package
+    freebsd:
+      version:
+      bugs: []
+  comments:     # cross-distro comments regarding this package
+  bugs: []      # upstream bugs opened
+  issues: []    # reproducible-issue identifiers that are cross-distro
+
+These are quite open, as none of these fields are formalized in a specification (yet!)
+
+### Issues with the current schema
+
+Here's a list of the current issues found with the current schema (
+
+- There doesn't seem to be a useful cross-distro mechanism for packages that
+  don't share the same name. THis means we may need a list of aliases in the
+  existing schema.
+- the cross-distro bugs and issues keys seem to need re-thinking
+- the version key seems to be a string, which raises doubts about how to
+  separate many-to-one issues when a package across different versions
+- We may want to formalize the ER diagram of all of these keys, as to avoid
+  issues like the one above. A proposal was added as er.gv and it can be compiled as:
+    dot er.gv -Tsvg -o output.svg



View it on GitLab: https://salsa.debian.org/reproducible-builds/reproducible-notes/commit/43f5eaee94c98233814a20c2536e74fd28c3b216

-- 
View it on GitLab: https://salsa.debian.org/reproducible-builds/reproducible-notes/commit/43f5eaee94c98233814a20c2536e74fd28c3b216
You're receiving this email because of your account on salsa.debian.org.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.reproducible-builds.org/pipermail/rb-commits/attachments/20181125/5447696e/attachment.html>