Updates from APL demo (#6)

* Updates for new revision

* Using pages deploy action directly

.github/workflows/rfc-check.yml

@@ -1,41 +1,59 @@
 name: RFC XML Check
 
 on: [push]
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
-  contents: write
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
 
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - name: dependencies
-      run: |
-        sudo apt-get install -y aspell cmake python3 python3-pip python3-setuptools python3-wheel ruby xmlstarlet
-        sudo pip3 install xml2rfc
-        sudo gem install cddl
-    - name: xml2rfc
-      run: |
-        cmake -S . -B build -DCMAKE_INSTALL_DOCDIR=$PWD/build/install
-        cmake --build build -v
-        cmake --install build
-    - uses: actions/upload-artifact@v3
-      with:
-        name: spec
-        path: build/install
+      - uses: actions/checkout@v3
+      - name: dependencies
+        run: |
+          sudo apt-get install -y aspell cmake python3 python3-pip python3-setuptools python3-wheel ruby xmlstarlet
+          sudo pip3 install --upgrade pip
+          sudo pip3 install xml2rfc
+          sudo gem install cddl
+      - name: xml2rfc
+        run: |
+          cmake -S . -B build -DCMAKE_INSTALL_DOCDIR=$PWD/build/install
+          cmake --build build -v
+          cmake --install build
+      - uses: actions/upload-artifact@v3
+        with:
+          name: spec
+          path: build/install
 
   deploy:
     if: github.ref == 'refs/heads/main'
     runs-on: ubuntu-latest
     needs: build
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
     steps:
-    - uses: actions/checkout@v3
-    - uses: actions/download-artifact@v3
-      with:
-        name: spec
-        path: build/install
-    - name: Deploy 🚀
-      uses: JamesIves/github-pages-deploy-action@4.1.0
-      with:
-        branch: gh-pages # The branch the action should deploy to.
-        folder: build/install # The folder the action should deploy.
+      - uses: actions/checkout@v3
+      - uses: actions/download-artifact@v3
+        with:
+          name: spec
+          path: build/install
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: build/install
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.gitlab-ci.yml

@@ -0,0 +1,58 @@
+default:
+  # All jobs run within a target-like environment
+  image: docker-remote.artifactory.jhuapl.edu/ubuntu:22.04
+
+include:
+  # Run pipeline only on branches, not MRs
+  - template: 'Workflows/Branch-Pipelines.gitlab-ci.yml'
+
+variables:
+  GIT_SUBMODULE_STRATEGY: recursive
+  DEBIAN_FRONTEND: "noninteractive"
+  # for Python/PIP
+  PIP_CERT: /etc/ssl/certs/ca-certificates.crt
+  PIP_DEFAULT_TIMEOUT: "300"
+  # Project-spcific environment
+  XDG_CACHE_HOME: "$CI_PROJECT_DIR/.cache"
+  PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
+
+stages:
+  - build
+
+cache:
+  paths:
+    - .cache/pip
+
+.prep-install-ca: &prep-install-ca |
+  apt-get update && apt-get install -y ca-certificates curl
+  mkdir -p /usr/local/share/ca-certificates
+  curl -svL http://apllinuxdepot.jhuapl.edu/linux/APL-root-cert/JHUAPL-MS-Root-CA-05-21-2038-B64-text.cer -o /usr/local/share/ca-certificates/JHUAPL-MS-Root-CA-05-21-2038-B64-text.crt
+  update-ca-certificates
+
+.prep-install-pip: &prep-install-pip |
+  apt-get update && apt-get install -y python3 python3-venv python3-pip python3-wheel
+  pip3 install --upgrade pip
+  pip3 install pip-tools
+
+.prep-install-doctools: &prep-install-doctools |
+  apt-get install -y aspell cmake ruby ruby-dev xmlstarlet yajl-tools xml2rfc
+  pip3 install xml2rfc
+  gem install cddl
+
+ari-doc:
+  stage: build
+  rules:
+    - changes:
+      - .gitlab-ci.yml
+      - spec/*
+  before_script:
+    - *prep-install-ca
+    - *prep-install-pip
+    - *prep-install-doctools
+  script:
+    - cmake -S . -B build/default -DCMAKE_INSTALL_DOCDIR=$PWD/build/install
+    - cmake --build build/default -v
+    - cmake --install build/default
+  artifacts:
+    paths:
+      - "build/install"

spec/CMakeLists.txt

@@ -127,7 +127,7 @@ else()
     add_custom_command(
         OUTPUT "${CDDLERRORS_TXT}"
         DEPENDS "${COMBINED_CDDL}"
-        COMMAND ${CDDLTOOL} "${COMBINED_CDDL}" generate 2>"${CDDLERRORS_TXT}" 1>&2 || true
+        COMMAND ${CDDLTOOL} "${COMBINED_CDDL}" generate 10 2>"${CDDLERRORS_TXT}" 1>&2 || true
     )
     add_custom_target(
         cddlerrors ALL

spec/dictionary.txt

@@ -1,45 +1,56 @@
-ACK
 Ack
+ACK
 acknowledgement
 acknowledgements
 anycast
+AQM
 BCP
+BER
+BPA
 BPSec
 BPv
 bstr
 bundleSecurity
 Burleigh
+bursty
 CAs
 CBOR
-CDDL
 cddl
+CDDL
 checksums
 ciphersuite
 CLA
 ClientHello
+codepoint
 codepoints
 connectionless
 Conv
 CRC
 CRLs
-Datagram
 datagram
+Datagram
 datagrams
 dbus
 DCCP
+de
 decodable
 deconflict
+DF
 DNS
 DTLS
-DTN
 dtn
+DTN
+ECN
+ECT
 EID
 EIDs
 encodings
 endian
 extensibility
+Heiner
 IANA
 ICMP
+ICMPv
 IESG
 IETF
 incrementing
@@ -49,38 +60,44 @@ IPADDR
 iPAddress
 IPsec
 IPv
-Keepalive
 keepalive
+Keepalive
 kp
 LLC
+middleboxes
 misconfigured
+MPS
 MRU
 MRUs
 MTU
-Multicast
 multicast
+Multicast
 ne
 ness
 nodeid
 OCSP
 packetization
 PCH
-Pipelining
 pipelining
+Pipelining
 PKI
 PKIX
+PKTINFO
 plaintext
+PLPMTUD
 PMTU
 pre
 PSK
 queueing
 Responder
 retransmission
 retransmissions
-Retransmit
 retransmit
+Retransmit
 retransmitted
 RKF
+routable
+Scalable
 SMI
 SSL
 STARTTLS
@@ -93,19 +110,19 @@ teardown
 TLS
 tstr
 UDP
-UDPCL
 udpcl
+UDPCL
 uint
 unhandled
 unicast
 untagged
 Untrusted
 URI
 UTF
-Wireshark
 wireshark
+Wireshark
 xA
 xBF
 xC
 xDF
-XPath
+XPath