Merge pull request #54 from ietf-rats-wg/mcr-wglc

editorial suggestions

.github/CODEOWNERS

@@ -1,10 +1,3 @@
-# Each line is a file pattern followed by one or more owners.
-# Refer to https://help.github.com/en/articles/about-code-owners
-
-# Order is important; the last matching pattern takes the most
-# precedence. Try to keep at least two owners (or an alias) per pattern.
-
-# These owners will be the default owners for everything in the repo.
-# Unless a later match takes precedence, they will be requested for
-# review when someone opens a pull request.
-* @dthaler @henkbirkholz @thomas-fossati
+# Automatically generated CODEOWNERS
+# Regenerate with `make update-codeowners`
+draft-ietf-rats-endorsements.md [email protected] [email protected] [email protected]

.github/workflows/archive.yml

@@ -16,9 +16,11 @@ jobs:
   build:
     name: "Archive Issues and Pull Requests"
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     steps:
     - name: "Checkout"
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
     # Note: No caching for this build!
 
@@ -37,6 +39,6 @@ jobs:
         token: ${{ github.token }}
 
     - name: "Save Archive"
-      uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08  # v4.6.0
+      uses: actions/upload-artifact@v4
       with:
         path: archive.json

.github/workflows/ghpages.yml

@@ -18,16 +18,18 @@ jobs:
   build:
     name: "Update Editor's Copy"
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     steps:
     - name: "Checkout"
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: "Setup"
       id: setup
       run: date -u "+date=%FT%T" >>"$GITHUB_OUTPUT"
 
     - name: "Caching"
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: |
           .refcache
@@ -51,9 +53,8 @@ jobs:
         token: ${{ github.token }}
 
     - name: "Archive Built Drafts"
-      uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08  # v4.6.0
+      uses: actions/upload-artifact@v4
       with:
         path: |
-          draft-*.xml
           draft-*.html
           draft-*.txt

.github/workflows/publish.yml

@@ -4,14 +4,20 @@ on:
   push:
     tags:
       - "draft-*"
+  workflow_dispatch:
+    inputs:
+      email:
+        description: "Submitter email"
+        default: ""
+        type: string
 
 jobs:
   build:
     name: "Publish New Draft Version"
     runs-on: ubuntu-latest
     steps:
     - name: "Checkout"
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     # See https://github.com/actions/checkout/issues/290
     - name: "Get Tag Annotations"
@@ -22,7 +28,7 @@ jobs:
       run: date -u "+date=%FT%T" >>"$GITHUB_OUTPUT"
 
     - name: "Caching"
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: |
           .refcache
@@ -42,8 +48,10 @@ jobs:
       uses: martinthomson/i-d-template@v1
       with:
         make: upload
+      env:
+        UPLOAD_EMAIL: ${{ inputs.email }}
 
     - name: "Archive Submitted Drafts"
-      uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08  # v4.6.0
+      uses: actions/upload-artifact@v4
       with:
         path: "versioned/draft-*-[0-9][0-9].*"

.github/workflows/update.yml

@@ -24,7 +24,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: "Checkout"
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
     - name: "Update Generated Files"
       uses: martinthomson/i-d-template@v1

.gitignore

@@ -7,17 +7,17 @@
 *~
 .tags
 /*-[0-9][0-9].xml
+/.*.mk
 /.gems/
 /.refcache
-/.targets.mk
 /.venv/
 /.vscode/
 /lib
 /node_modules/
 /versioned/
 Gemfile.lock
 archive.json
-draft-dthaler-rats-endorsements.xml
+draft-ietf-rats-endorsements.xml
 package-lock.json
 report.xml
 !requirements.txt

CONTRIBUTING.md

@@ -15,6 +15,8 @@ repository constitutes Contributions to the IETF Standards Process
 You agree to comply with all applicable IETF policies and procedures, including,
 BCP 78, 79, the TLP, and the TLP rules regarding code components (e.g. being
 subject to a Simplified BSD License) in Contributions.
+
+
 ## Working Group Information
 
 Discussion of this work occurs on the [Remote ATtestation ProcedureS

LICENSE.md

@@ -1,4 +1,4 @@
 # License
 
 See the
-[guidelines for contributions](https://github.com/dthaler/rats-endorsements/blob/main/CONTRIBUTING.md).
+[guidelines for contributions](https://github.com/ietf-rats-wg/rats-endorsements/blob/main/CONTRIBUTING.md).

Makefile

@@ -4,8 +4,12 @@ include $(LIBDIR)/main.mk
 $(LIBDIR)/main.mk:
 ifneq (,$(shell grep "path *= *$(LIBDIR)" .gitmodules 2>/dev/null))
 	git submodule sync
-	git submodule update $(CLONE_ARGS) --init
+	git submodule update --init
 else
-	git clone -q --depth 10 $(CLONE_ARGS) \
-	    -b main https://github.com/martinthomson/i-d-template $(LIBDIR)
+ifneq (,$(wildcard $(ID_TEMPLATE_HOME)))
+	ln -s "$(ID_TEMPLATE_HOME)" $(LIBDIR)
+else
+	git clone -q --depth 10 -b main \
+	    https://github.com/martinthomson/i-d-template $(LIBDIR)
+endif
 endif

README.md

@@ -1,17 +1,17 @@
 # RATS Endorsements
 
-This is the working area for the individual Internet-Draft, "RATS Endorsements".
+This is the working area for the IETF [RATS Working Group](https://datatracker.ietf.org/group/rats/documents/) Internet-Draft, "RATS Endorsements".
 
-* [Editor's Copy](https://htmlpreview.github.io/?https://raw.githubusercontent.com/ietf-rats-wg/rats-endorsements/gh-pages/draft-ietf-rats-endorsements.html)
+* [Editor's Copy](https://ietf-rats-wg.github.io/rats-endorsements/#go.draft-ietf-rats-endorsements.html)
 * [Datatracker Page](https://datatracker.ietf.org/doc/draft-ietf-rats-endorsements)
-* [WG Draft](https://datatracker.ietf.org/doc/html/draft-ietf-rats-endorsements)
-* [Compare Editor's Copy to WG Draft](https://author-tools.ietf.org/diff?doc_1=draft-ietf-rats-endorsements&url_2=https://raw.githubusercontent.com/ietf-rats-wg/rats-endorsements/gh-pages/draft-ietf-rats-endorsements.txt&wdiff=1)
+* [Working Group Draft](https://datatracker.ietf.org/doc/html/draft-ietf-rats-endorsements)
+* [Compare Editor's Copy to Working Group Draft](https://ietf-rats-wg.github.io/rats-endorsements/#go.draft-ietf-rats-endorsements.diff)
 
 
 ## Contributing
 
 See the
-[guidelines for contributions](https://github.com/dthaler/rats-endorsements/blob/main/CONTRIBUTING.md).
+[guidelines for contributions](https://github.com/ietf-rats-wg/rats-endorsements/blob/main/CONTRIBUTING.md).
 
 Contributions can be made by creating pull requests.
 The GitHub interface supports creating pull requests using the Edit (✏) button.

draft-ietf-rats-endorsements.md

@@ -113,11 +113,10 @@ a set of potential values, being the values that are allowed/disallowed
 when determining the trustworthiness of the Attester.  In general, there may be more
 gradation than simply "allowed or disallowed" so each value might include some
 more complex level of gradation in some implementations.
-
-That is, where actual state has a single value per claim per Target Environment
-applying to one device at one point in time, reference state can have a set of values
-per claim per Target Environment.  Appraisal policy then specifies how to match
-the actual state values against a set of Reference Values.
+Reference state can have a set of values per claim per Target Environment.
+This is contrasted with actual state, which has a single value per claim per Target Environment.
+Actual state applies to one device at one point in time.
+Appraisal policy then specifies how to match the actual state values against a set of Reference Values.
 
 Some examples of such matching include:
 
@@ -229,8 +228,8 @@ Typically,
 the bottom-most Attesting Environment in an Attester will sign claims about one or more Target Environments
 (see also the DICE example at the end of {{conceptual}})
 with a private key that the Attesting Environment possesses, and the Verifier will appraise
-the resulting Evidence with a public key it possesses, called a verification key below. While this is typical,
-cryptography other than public key may also be used.
+the resulting Evidence with a public key it possesses, called a verification key below.
+While use of public key cryptography is typical for a verification key, cryptography other than public key may also be used.
 
 Endorsing the linkage between such verification keys and their associated Attesting Environments is crucial to the verification process.