Change the approach to IETF builds to support for md I-Ds

Author: jdesrosiers

.github/workflows/ci.yml

@@ -19,17 +19,9 @@ jobs:
   specs-ietf:
     runs-on: ubuntu-latest
     steps:
+      - name: Install docker-compose
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y docker-compose
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-        with:
-          python-version: "3.10"
-      - run: pip install --requirement requirements.txt
-      - run: xml2rfc --version
-      - run: make all
-      - uses: actions/upload-artifact@v4
-        with:
-          name: specification-docs
-          path: |
-              *.html
-              *.txt
-              !requirements.txt
+      - run: npm run build-ietf

.gitignore

@@ -2,17 +2,7 @@
 web/
 
 # IETF builds
-json-schema-use-cases.html
-json-schema-use-cases.pdf
-json-schema-use-cases.txt
-relative-json-pointer.html
-relative-json-pointer.pdf
-relative-json-pointer.txt
-
-# For the Python enviornment
-.venv
+.refcache/
 
 # For the node-based build tools
 node_modules/
-
-.env

Dockerfile

@@ -0,0 +1,14 @@
+FROM fedora
+
+RUN dnf install -y ruby python3-pip
+RUN gem install kramdown-rfc
+RUN pip install xml2rfc
+
+WORKDIR /app
+
+COPY . .
+
+# First covert md to xml. Then convert xml to html
+CMD sh -c "xml2rfc --version \
+        && ls ietf/*.md | xargs -n1 sh -c 'kramdown-rfc \"\$0\" > \"\${0%.md}.xml\"' \
+        && ls ietf/*.xml | xargs -n1 sh -c 'xml2rfc --html \"\$0\" -p web'"

Makefile

@@ -113,17 +113,7 @@ features they make available to you.
 ### Internet-Drafts
 
 To build components that are being maintained as IETF Internet-Drafts, run
-`make`. The Makefile will create the necessary Python venv for you as part of
-the regular make target.
-
-`make clean` will remove all output including the venv. To clean just the spec
-output and keep the venv, use `make spec-clean`.
-
-If you want to run `xml2rfc` manually after running make for the first time, you
-will need to activate the virtual environment: `source .venv/bin/activate`.
-
-The version of "xml2rfc" that this project uses is updated by modifying
-`requirements.in` and running `pip-compile requirements.in`.
+`npm run build-ietf`.
 
 Descriptions of the xml2rfc, I-D documents, and RFC processes:
 

README.md

@@ -0,0 +1,7 @@
+services:
+  build:
+    build:
+      context: .
+    working_dir: /app
+    volumes:
+      - .:/app:Z

docker-compose.yml

@@ -0,0 +1,12 @@
+import lintPreset from "../.remarkrc-lint.js";
+import remarkLintNoMultipleToplevelHeadings from "remark-lint-no-multiple-toplevel-headings";
+import remarkLintFencedCodeMarker from "remark-lint-fenced-code-marker";
+
+
+export default {
+  plugins: [
+    lintPreset,
+    [remarkLintNoMultipleToplevelHeadings, false],
+    [remarkLintFencedCodeMarker, "~"]
+  ]
+};

ietf/.remarkrc.js

@@ -0,0 +1,32 @@
+---
+
+stand_alone: true
+ipr: trust200902
+submissiontype: independent
+category: info
+
+author:
+- name: Jason Desrosiers
+  email: [email protected]
+  role: editor
+
+title: Example
+
+--- abstract
+
+An example of an I-D in markdown
+
+--- middle
+
+# Introduction
+
+## Notational Conventions
+
+{::boilerplate bcp14+}
+
+# Security Considerations
+
+TODO: Required section
+
+--- back
+