netmod-wg · kwatsen · May 22, 2024 · May 22, 2024 · May 22, 2024 · May 22, 2024
diff --git a/.authors.txt b/.authors.txt
@@ -1,4 +1,7 @@
 <!-- This file re-generated by a GitHub workflow action -->
-<author initials="K" surname="Watsen" fullname="Kent Watsen">
-  <organization>Watsen Networks</organization>
+<author initials="F" surname="Bar" fullname="Foo Bar">
+  <organization>ACME, Inc.</organization>
+  <address>
+    <email>[email protected]</email>
+  </address>
 </author>
diff --git a/.github/workflows/gen_author_list.sh b/.github/workflows/gen_author_list.sh
@@ -46,20 +46,18 @@ sorted_xml_authors() {
   # output authors as an XML <author> element
   for a in $AUTHORS; do
 
-    if [ $a == "kent" ]; then
-      #echo "skipping author 'kent'"
-      #exit 1 # let's see if we can't first this
-      continue
-    fi
-
     FULL_NAME=`grep $a $0 | awk -F'"' '{print $2}'`
     ORGANIZATION=`grep $a $0 | awk -F'"' '{print $4}'`
     FIRST_NAME=`echo $FULL_NAME | awk '{print $1}'`
     LAST_NAME=`echo $FULL_NAME | awk '{print $2}'`
     FIRST_INITIAL=${FIRST_NAME:0:1}
+    EMAIL=`grep $a $0 | awk -F'"' '{print $6}'`
 
     echo "<author initials=\"$FIRST_INITIAL\" surname=\"$LAST_NAME\" fullname=\"$FULL_NAME\">"
     echo "    <organization>$ORGANIZATION</organization>"
+    echo "    <address>"
+    echo "        <email>$EMAIL</email>"
+    echo "    </address>"
     echo "</author>"
   done
 }
@@ -79,4 +77,4 @@ main "$@"
 
 
 #### AUTHOR INFO ####
-#kwatsen: "Kent Watsen" "Watsen Networks"
+#kwatsen: "Kent Watsen" "Watsen Networks" "[email protected]"
diff --git a/.github/workflows/gen_index_html.sh b/.github/workflows/gen_index_html.sh
@@ -9,7 +9,7 @@ for d in */; do
   dd=`echo $d | sed 's#/$##'`
   echo "$dd $DATE" >> sort.txt
 done
-SORTED=`sort -r -k 1 sort.txt | awk '{print $1}'`
+SORTED=`sort -r -k 2 sort.txt | awk '{print $1}'`
 
 # create the index.html file
 echo "<html>" > index.html
@@ -20,7 +20,7 @@ echo "    tr.bg:nth-child(odd) {background-color: #f2f2f2}" >> index.html
 echo "    tr.bg:nth-child(even) {background-color: white}" >> index.html
 echo "    th.bg    {background-color: #A0A0A0; color: white;}" >> index.html
 echo "    th.bg,td.bg {padding: 15px; text-align: left; vertical-align: top;}" >> index.html
-echo "    td.fg {text-align: right; vertical-align: bottom;}" >> index.html
+echo "    td.fg {text-align: right; vertical-align: bottom; white-space: nowrap;}" >> index.html
 echo "  </style>" >> index.html
 echo "  <base target=\"_blank\">" >> index.html
 echo "</head>" >> index.html
@@ -32,25 +32,37 @@ echo "<table class=\"bg\">" >> index.html
 echo "  <tr class=\"bg\">" >> index.html
 echo "    <th class=\"bg\"><b>Updated</b></th>" >> index.html
 echo "    <th class=\"bg\"><b>Pull Request</b></th>" >> index.html
-echo "    <th class=\"bg\"><b>Branch Name</b></th>" >> index.html
+echo "    <th class=\"bg\"><b>Merge Operation</b></th>" >> index.html
 echo "    <th class=\"bg\"><b>Formats</b></th>" >> index.html
 echo "    <th class=\"bg\"><b>Actions</b></th>" >> index.html
 echo "  </tr>" >> index.html
-for d in $SORTED; do
+for branch in $SORTED; do
   echo "  <tr class=\"bg\">" >> index.html
-  NUMBER=`grep NUMBER $d/metadata.txt | awk '{print $2}'`
-  TITLE=`grep TITLE $d/metadata.txt | awk '{for (i=2; i<NF; i++) printf $i " "; print $NF}'`
-  DATE=`grep DATE $d/metadata.txt | awk '{print $2}'`
-  echo "    <td class=\"bg\">$DATE</td>" >> index.html
-  echo "    <td class=\"bg\"><a href=\"https://github.com/netmod-wg/rfc7950bis-and-friends/pull/$NUMBER\">$TITLE (#$NUMBER)</a></td>" >> index.html
-  echo "    <td class=\"bg\"><a href=\"https://github.com/netmod-wg/rfc7950bis-and-friends/tree/$d\">$d</a></td>" >> index.html
+  NUMBER=`grep NUMBER $branch/metadata.txt | awk '{print $2}'`
+  TITLE=`grep TITLE $branch/metadata.txt | awk '{for (i=2; i<NF; i++) printf $i " "; print $NF}'`
+  DATE=`grep DATE $branch/metadata.txt | awk '{print $2}'`
+  grep -q BASE $branch/metadata.txt || BASE="main" # delete this after PR #36 merges...
+  grep -q BASE $branch/metadata.txt && BASE=`grep BASE $branch/metadata.txt | awk '{print $2}'`
+  echo "    <td class=\"bg\" nowrap>$DATE</td>" >> index.html
 
-  echo "    <td class=\"bg\"> <table> <tr> <td class=\"fg\">rfc7950bis:</td> <td><a href=\"$d/draft-yn-netmod-rfc7950bis-00.html\">html</a> / <a href=\"$d/draft-yn-netmod-rfc7950bis-00.txt\">text</a> / <a href=\"$d/draft-yn-netmod-rfc7950bis-00.xml\">xml</a></td> </tr> <tr> <td class=\"fg\">yang-xml:</td> <td><a href=\"$d/draft-yn-netmod-yang-xml-00.html\">html</a> / <a href=\"$d/draft-yn-netmod-yang-xml-00.txt\">text</a> / <a href=\"$d/draft-yn-netmod-yang-xml-00.xml\">xml</a></td> </tr> <tr> <td class=\"fg\">yang-proto:</td> <td><a href=\"$d/draft-yn-netmod-yang-proto-00.html\">html</a> / <a href=\"$d/draft-yn-netmod-yang-proto-00.txt\">text</a> / <a href=\"$d/draft-yn-netmod-yang-proto-00.proto\">xml</a></td> </tr> </table> </td>" >> index.html
+  if [ $branch = "main" ]; then
+    echo "    <td class=\"bg\">N/A, since this is the \"main\" branch (last updated by <a href=\"https://github.com/netmod-wg/rfc7950bis-and-friends/pull/$NUMBER\">#$NUMBER: $TITLE</a>).</td>" >> index.html
+  else
+    echo "    <td class=\"bg\"><a href=\"https://github.com/netmod-wg/rfc7950bis-and-friends/pull/$NUMBER\">#$NUMBER: $TITLE</a></td>" >> index.html
+  fi
+
+  if [ $branch = "main" ]; then
+    echo "    <td class=\"bg\">N/A, since this is the <a href=\"https://github.com/netmod-wg/rfc7950bis-and-friends/tree/main\">\"main\"</a> branch.</td>" >> index.html
+  else
+    echo "    <td class=\"bg\">Branch <a href=\"https://github.com/netmod-wg/rfc7950bis-and-friends/tree/$branch\">\"$branch\"</a> merges into branch <a href=\"https://github.com/netmod-wg/rfc7950bis-and-friends/tree/$BASE\">\"$BASE\"</a>.</td>" >> index.html
+  fi
+
+  echo "    <td nowrap class=\"bg\"> <table> <tr> <td class=\"fg\">rfc7950bis:</td> <td nowrap><a href=\"$branch/draft-yn-netmod-rfc7950bis-00.html\">html</a> / <a href=\"$branch/draft-yn-netmod-rfc7950bis-00.txt\">text</a> / <a href=\"$branch/draft-yn-netmod-rfc7950bis-00.xml\">xml</a></td> </tr> <tr> <td class=\"fg\">yang-xml:</td> <td nowrap><a href=\"$branch/draft-yn-netmod-yang-xml-00.html\">html</a> / <a href=\"$branch/draft-yn-netmod-yang-xml-00.txt\">text</a> / <a href=\"$branch/draft-yn-netmod-yang-xml-00.xml\">xml</a></td> </tr> <tr> <td class=\"fg\">yang-proto:</td> <td nowrap><a href=\"$branch/draft-yn-netmod-yang-proto-00.html\">html</a> / <a href=\"$branch/draft-yn-netmod-yang-proto-00.txt\">text</a> / <a href=\"$branch/draft-yn-netmod-yang-proto-00.proto\">xml</a></td> </tr> </table> </td>" >> index.html
 
-  if [ $d = "main" ]; then
-    echo "    <td class=\"bg\"><table> <tr> <td class=\"fg\">rfc7950bis:</td> <td><a href=\"https://author-tools.ietf.org/diff?doc_1=rfc7950&url_2=https://netmod-wg.github.io/rfc7950bis-and-friends/main/draft-yn-netmod-rfc7950bis-00.txt\">Diff with RFC7950</a><br><a href=\"https://author-tools.ietf.org/api/iddiff?doc_1=draft-yn-netmod-rfc7950bis&url_2=https://netmod-wg.github.io/rfc7950bis-and-friends/main/draft-yn-netmod-rfc7950bis-00.txt\"><s>Diff with Datatracker</s></a></td>  </tr> <tr><td class=\"fg\">yang-xml:</td><td><a href=\"https://author-tools.ietf.org/api/iddiff?doc_1=draft-yn-netmod-yang-xml&url_2=https://netmod-wg.github.io/yang-xml/main/draft-yn-netmod-yang-xml-00.txt\"><s>Diff with Datatracker</s></a></td></tr> <tr><td class=\"fg\">yang-proto:</td><td><a href=\"https://author-tools.ietf.org/api/iddiff?doc_1=draft-yn-netmod-yang-xml&url_2=https://netmod-wg.github.io/yang-xml/main/draft-yn-netmod-yang-proto-00.txt\"><s>Diff with Datatracker</s></a></td></tr></table> </td>" >> index.html
+  if [ $branch = "main" ]; then
+    echo "    <td nowrap class=\"bg\"><table> <tr> <td class=\"fg\">rfc7950bis:</td> <td nowrap><a href=\"https://author-tools.ietf.org/diff?doc_1=rfc7950&url_2=https://netmod-wg.github.io/rfc7950bis-and-friends/main/draft-yn-netmod-rfc7950bis-00.txt\">Diff with RFC7950</a><br><a href=\"https://author-tools.ietf.org/api/iddiff?doc_1=draft-yn-netmod-rfc7950bis&url_2=https://netmod-wg.github.io/rfc7950bis-and-friends/main/draft-yn-netmod-rfc7950bis-00.txt\"><s>Diff with Datatracker</s></a></td>  </tr> <tr><td class=\"fg\">yang-xml:</td><td nowrap><a href=\"https://author-tools.ietf.org/api/iddiff?doc_1=draft-yn-netmod-yang-xml&url_2=https://netmod-wg.github.io/yang-xml/main/draft-yn-netmod-yang-xml-00.txt\"><s>Diff with Datatracker</s></a></td></tr> <tr><td class=\"fg\">yang-proto:</td><td nowrap><a href=\"https://author-tools.ietf.org/api/iddiff?doc_1=draft-yn-netmod-yang-proto&url_2=https://netmod-wg.github.io/yang-proto/main/draft-yn-netmod-yang-proto-00.txt\"><s>Diff with Datatracker</s></a></td></tr></table> </td>" >> index.html
   else
-    echo "    <td class=\"bg\"> <table> <tr> <td class=\"fg\">rfc7950bis:</td> <td><a href=\"https://author-tools.ietf.org/api/iddiff?url_1=https://netmod-wg.github.io/rfc7950bis-and-friends/main/draft-yn-netmod-rfc7950bis-00.txt&url_2=https://netmod-wg.github.io/rfc7950bis-and-friends/$d/draft-yn-netmod-rfc7950bis-00.txt\">Diff with Main</a></td> </tr> <tr> <td class=\"fg\">yang-xml:</td> <td><a href=\"https://author-tools.ietf.org/api/iddiff?url_1=https://netmod-wg.github.io/rfc7950bis-and-friends/main/draft-yn-netmod-yang-xml-00.txt&url_2=https://netmod-wg.github.io/rfc7950bis-and-friends/$d/draft-yn-netmod-yang-xml-00.txt\">Diff with Main</a></td> </tr> <tr> <td class=\"fg\">yang-proto:</td> <td><a href=\"https://author-tools.ietf.org/api/iddiff?url_1=https://netmod-wg.github.io/rfc7950bis-and-friends/main/draft-yn-netmod-yang-proto-00.txt&url_2=https://netmod-wg.github.io/rfc7950bis-and-friends/$d/draft-yn-netmod-yang-proto-00.txt\">Diff with Main</a></td> </tr> </table> </td>" >> index.html
+    echo "    <td nowrap class=\"bg\"> <table> <tr> <td class=\"fg\">rfc7950bis:</td> <td nowrap><a href=\"https://author-tools.ietf.org/api/iddiff?url_1=https://netmod-wg.github.io/rfc7950bis-and-friends/$BASE/draft-yn-netmod-rfc7950bis-00.txt&url_2=https://netmod-wg.github.io/rfc7950bis-and-friends/$branch/draft-yn-netmod-rfc7950bis-00.txt\">Diff with Base</a></td> </tr> <tr> <td class=\"fg\">yang-xml:</td> <td nowrap><a href=\"https://author-tools.ietf.org/api/iddiff?url_1=https://netmod-wg.github.io/rfc7950bis-and-friends/$BASE/draft-yn-netmod-yang-xml-00.txt&url_2=https://netmod-wg.github.io/rfc7950bis-and-friends/$branch/draft-yn-netmod-yang-xml-00.txt\">Diff with Base</a></td> </tr> <tr> <td class=\"fg\">yang-proto:</td> <td nowrap><a href=\"https://author-tools.ietf.org/api/iddiff?url_1=https://netmod-wg.github.io/rfc7950bis-and-friends/$BASE/draft-yn-netmod-yang-proto-00.txt&url_2=https://netmod-wg.github.io/rfc7950bis-and-friends/$branch/draft-yn-netmod-yang-proto-00.txt\">Diff with Base</a></td> </tr> </table> </td>" >> index.html
   fi
   echo "  </tr>" >> index.html
 done

diff --git a/.github/workflows/pull_request_updated.yml b/.github/workflows/pull_request_updated.yml
@@ -171,9 +171,11 @@ jobs:
       # stash some metadata
       - name: Stash some metadata
         run: |
+          echo "${{github.event.pull_request}}"
           echo "NUMBER: ${{github.event.pull_request.number}}" > mysite/${{github.head_ref}}/metadata.txt
           echo "TITLE: ${{github.event.pull_request.title}}" >> mysite/${{github.head_ref}}/metadata.txt
           echo "DATE: $(date +%Y-%m-%dT%H:%M:%SZ)" >> mysite/${{github.head_ref}}/metadata.txt
+          echo "BASE: ${{github.base_ref}}" >> mysite/${{github.head_ref}}/metadata.txt
 
       # delete the artifacts
       - uses: geekyeggo/delete-artifact@v5

diff --git a/.gitignore b/.gitignore
@@ -1 +1,3 @@
 draft-yn-netmod-rfc7950bis-*
+draft-yn-netmod-yang-xml-*
+draft-yn-netmod-yang-proto-*
diff --git a/Makefile b/Makefile
@@ -62,6 +62,7 @@ clean:
 	done
 
 clean_draft:
+	-rm -f $(draft)-[0-9][0-9].v2v3.xml
 	-rm -f $(draft)-[0-9][0-9].xml
 	-rm -f $(draft)-[0-9][0-9].txt
 	-rm -f $(draft)-[0-9][0-9].html

diff --git a/designs/creating-xml-yang-doc.md b/designs/creating-xml-yang-doc.md
@@ -0,0 +1,7 @@
+# Creating the "xml-yang" Document
+
+  - copy overall structure from RFC 7951
+  - name "yang-xml" since 7951's doc was originally called "yang-json"
+  - for each section:
+      - copy/edit text from RFC 7951
+      - move/edit text from RFC 7950