Merge branch 'master' of https://github.com/martinthomson/i-d-template

# Conflicts:
#	.circleci/config.yml
#	.gitignore
#	CONTRIBUTING.md
#	LICENSE.md
#	README.md

Author: wolfmcnally

.circleci/config.yml

@@ -3,93 +3,29 @@ jobs:
   build:
     docker:
       - image: martinthomson/i-d-template:latest
-    resource_class: small
     working_directory: ~/draft
 
     steps:
-      - run:
-          name: "Print Configuration"
-          command: |
-            xml2rfc --version
-            gem list -q kramdown-rfc
-            echo -n 'mmark '; mmark --version
-
-      - restore_cache:
-          name: "Restoring cache - Git"
-          keys:
-            - v2-cache-git-{{ .Branch }}-{{ .Revision }}
-            - v2-cache-git-{{ .Branch }}
-            - v2-cache-git-
-
-      - restore_cache:
-          name: "Restoring cache - References"
-          keys:
-            - v1-cache-references-{{ epoch }}
-            - v1-cache-references-
-
-      # Workaround for https://discuss.circleci.com/t/22437
-      - run:
-          name: Tag Checkout
-          command: |
-            if [ -n "$CIRCLE_TAG" ] && [ -d .git ]; then
-              remote=$(echo "$CIRCLE_REPOSITORY_URL" | \
-                       sed -e 's,/^git.github.com:,https://github.com/,')
-              git fetch -f "$remote" "refs/tags/$CIRCLE_TAG:refs/tags/$CIRCLE_TAG" || \
-                (echo 'Removing .git cache for tag build'; rm -rf .git)
-            fi
-
       - checkout
 
-      # Build txt and html versions of drafts
-      - run:
-          name: "Build Drafts"
-          command: make
-
-      # Update editor's copy on gh-pages
       - run:
-          name: "Update GitHub Pages"
+          name: "Check Formatting"
           command: |
-            if [ "${CIRCLE_TAG#draft-}" == "$CIRCLE_TAG" ]; then
-              make gh-pages
-            fi
+            pip3 install --user black==19.3b0 && ln -s $HOME/.local/bin/black $BINDIR
+            black --check .
 
-      # For tagged builds, upload to the datatracker.
-      - deploy:
-          name: "Upload to Datatracker"
+      - run:
+          name: "Run Tests"
           command: |
-            if [ "${CIRCLE_TAG#draft-}" != "$CIRCLE_TAG" ]; then
-              make upload
+            if [ -z "$CIRCLE_TAG" ]; then
+              pip3 install --user behave && ln -s $HOME/.local/bin/behave $BINDIR
+              mkdir -p /tmp/artifacts
+              behave --junit --junit-directory /tmp/artifacts tests/*.feature
             fi
 
-      # Archive GitHub Issues
-      - run:
-          name: "Archive GitHub Issues"
-          command: "make archive || make archive DISABLE_ARCHIVE_FETCH=true && make gh-archive"
-
-      # Create and store artifacts
-      - run:
-          name: "Create Artifacts"
-          command: "make artifacts CI_ARTIFACTS=/tmp/artifacts"
-
       - store_artifacts:
           path: /tmp/artifacts
 
-      - run:
-          name: "Prepare for Caching"
-          command: "git reflog expire --expire=now --all && git gc --prune=now"
-
-      - save_cache:
-          name: "Saving Cache - Git"
-          key: v2-cache-git-{{ .Branch }}-{{ .Revision }}
-          paths:
-            - ~/draft/.git
-
-      - save_cache:
-          name: "Saving Cache - Drafts"
-          key: v1-cache-references-{{ epoch }}
-          paths:
-            - ~/.cache/xml2rfc
-
 
 workflows:
   version: 2

.gitattributes

@@ -0,0 +1,3 @@
+# Force *.sed and *.sh files to use LF for EOL -- CRLF breaks
+*.sed text eol=lf
+*.sh text eol=lf

.github/workflows/docker.yml

@@ -0,0 +1,40 @@
+name: "Update Docker Image for GitHub Action"
+
+on:
+  push:
+    paths:
+    - "docker/**"
+    - ".github/workflows/docker.yml"
+  schedule:
+    # Once monthly at a randomly selected time.
+    - cron: "24 3 18 * *"
+
+jobs:
+  build:
+    name: "Update Docker Image"
+    runs-on: ubuntu-latest
+    steps:
+    - name: "Checkout"
+      uses: actions/checkout@v2
+
+    - name: "Get Tag"
+      id: tag
+      run: |
+        ref="${{ github.ref }}"
+        if [ "$ref" = "refs/heads/master" ]; then
+          echo "::set-output name=tag::latest"
+        elif [ "${ref#refs/tags/}" != "$ref" ]; then
+          echo "::set-output name=tag::${ref#refs/tags/}"
+        else
+          echo "::set-output name=tag::"
+        fi
+
+    - name: "Publish to Dockerhub"
+      uses: docker/build-push-action@v1
+      with:
+        username: ${{ secrets.DOCKER_USERNAME }}
+        password: ${{ secrets.DOCKER_PASSWORD }}
+        repository: martinthomson/i-d-template-action
+        path: action
+        tags: ${{ steps.tag.outputs.tag }}
+        push: ${{ steps.tag.outputs.tag != '' }}

.gitignore

@@ -1,18 +1,15 @@
 *.html
 *.pdf
 *.redxml
-*.swp
 *.txt
 *.upload
-*~
 .tags
 /*-[0-9][0-9].xml
 /.gems/
 /.refcache
 /.targets.mk
 /.venv/
 /.vscode/
-/lib
 /node_modules/
 /versioned/
 Gemfile.lock
@@ -21,3 +18,13 @@ draft-mcnally-deterministic-cbor.xml
 package-lock.json
 report.xml
 !requirements.txt
+*~
+*.swp
+lib
+rfc2629xslt
+*.xslt
+.template-files.mk
+draft-*
+issues.json
+pulls.json
+*.DS_Store

CONTRIBUTING.md

@@ -1,3 +1,5 @@
+This project is in the public domain; your contributions need to be too.
+
 # Contributing
 
 This repository relates to activities in the Internet Engineering Task Force

action.yml

@@ -0,0 +1,19 @@
+name: 'Internet-Draft CI'
+description: 'Tool for building Internet-Drafts as GitHub Actions'
+author: 'Martin Thomson <[email protected]>'
+
+inputs:
+  make:
+    description: 'The make target to build'
+    required: false
+    default: 'latest'
+
+runs:
+  using: 'docker'
+  image: 'docker://martinthomson/i-d-template-action:latest'
+  args:
+    - ${{ inputs.make }}
+
+branding:
+  icon: 'check-square'
+  color: 'green'

action/.dockerignore

@@ -0,0 +1,2 @@
+*~
+*.swp

action/Dockerfile

@@ -0,0 +1,53 @@
+FROM ubuntu:18.04
+LABEL maintainer="Martin Thomson <[email protected]>"
+
+RUN apt-get update && \
+    DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
+    ca-certificates \
+    coreutils \
+    curl \
+    git \
+    libxml2-utils \
+    make \
+    mmark \
+    python3-certifi \
+    python3-chardet \
+    python3-dateutil \
+    python3-idna \
+    python3-intervaltree \
+    python3-lxml \
+    python3-minimal \
+    python3-pip \
+    python3-pycountry \
+    python3-pyflakes \
+    python3-requests \
+    python3-setuptools \
+    python3-sortedcontainers \
+    python3-urllib3 \
+    python3-webencodings \
+    python3-wheel \
+    ruby \
+    ssh \
+    xsltproc \
+ && rm -rf /var/lib/apt/lists/* /var/log/dpkg.log \
+ && apt-get autoremove -y && apt-get clean -y
+
+ENV SHELL /bin/bash
+
+RUN set -e; tool_install() { \
+      tool="$1";version="$2";sha="$3"; tmp=$(mktemp -t "${tool}XXXXX.tgz"); \
+      curl -sSLf "https://tools.ietf.org/tools/${tool}/${tool}-${version}".tgz -o "$tmp"; \
+      [ $(sha256sum -b "$tmp" | cut -d ' ' -f 1 -) = "$sha" ]; \
+      target="/usr/local/bin/${tool}"; \
+      tar xzfO "$tmp" "${tool}-${version}/${tool}" >"$target"; rm -f "$tmp"; \
+      chmod 755 "$target"; }; \
+    tool_install idnits 2.16.04 \
+      1eef34b131d9c0b45090192f972db0b5dae15047271a7962959c8019dd8cc06b && \
+    tool_install rfcdiff 1.47 \
+      75a9e83869885836c024a94f35128eaf292c6b9de3fd9d3361fbc62d46ec9f16
+
+RUN pip3 install --compile xml2rfc
+RUN gem install --no-doc kramdown-rfc2629
+
+COPY entrypoint.sh /entrypoint.sh
+ENTRYPOINT ["/entrypoint.sh"]

action/entrypoint.sh

@@ -0,0 +1,4 @@
+#!/bin/sh
+set -e
+make .targets.mk
+make "$@"

add-note.py

@@ -0,0 +1,30 @@
+#!/usr/bin/env python3
+
+import fileinput
+import re
+
+found = False
+frontEnd = re.compile(" *</front>")
+for line in fileinput.input():
+    if not found:
+        match = frontEnd.match(line)
+        if match:
+            found = True
+            if match.start() > 0:
+                print(line[: match.start()], end="")
+
+            try:
+                with fileinput.FileInput(files=(".note.xml")) as note:
+                    for n in note:
+                        print(n, end="")
+            except:
+                pass
+
+            print(line[match.start() :], end="")
+            continue
+
+        # Don't add a note if there is one already.
+        if line.find("</note>") >= 0:
+            found = True
+
+    print(line, end="")