From 3b73cb85aadc87451bfdd8c4a17d1041d6c99062 Mon Sep 17 00:00:00 2001 From: Dean Eigenmann <7621705+decanus@users.noreply.github.com> Date: Wed, 20 May 2020 09:03:40 +0200 Subject: [PATCH] github-actions-readme-spelling (#127) * Create main.yml * Delete .travis.yml * Update README.md * Update main.yml * Create wordlist.txt * Update README.md * Create spellcheck.yaml * Update wordlist.txt * Update wordlist.txt * Update spellcheck.yaml * Update wordlist.txt * Update mvds-metadata.md * Update wordlist.txt * spelling * more * fixes * filter comments * spelling corrections, wordlist * more fixes * formt * undid * filter * remove * url * i think thats it * fix * removed to test * sorted * Update spellcheck.yaml * Update main.yml * trying * Update wordlist.txt * Update wordlist.txt * Update wordlist.txt * Update README.md * Update wordlist.txt --- .github/workflows/main.yml | 31 +++++++ .travis.yml | 15 ---- README.md | 14 ++- specs/mvds-metadata.md | 8 +- specs/mvds.md | 6 +- specs/remote-log.md | 4 +- specs/waku/envelope-data-format.md | 2 +- specs/waku/waku-0.md | 16 ++-- specs/waku/waku-1.md | 12 +-- spellcheck.yaml | 20 +++++ wordlist.txt | 134 +++++++++++++++++++++++++++++ 11 files changed, 222 insertions(+), 40 deletions(-) create mode 100644 .github/workflows/main.yml delete mode 100644 .travis.yml create mode 100644 spellcheck.yaml create mode 100644 wordlist.txt diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 00000000..736845bf --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,31 @@ +# This is a basic workflow to help you get started with Actions + +name: CI + +# Controls when the action will run. Triggers the workflow on push or pull request +# events but only for the master branch +on: [pull_request] + +jobs: + spellcheck: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + + - name: Spellcheck Action + uses: rojopolis/spellcheck-github-actions@0.2.0 + + lint: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Set up Node.js + uses: actions/setup-node@master + with: + node-version: 13 + - name: Install + run: npm install + - name: Test + run: npm run lint diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index e8348b5f..00000000 --- a/.travis.yml +++ /dev/null @@ -1,15 +0,0 @@ -sudo: required - -dist: trusty - -language: node_js - -node_js: - - "8" - -script: - - npm run lint - -notifications: - email: false - diff --git a/README.md b/README.md index 25b39d68..c741782f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![Build Status](https://travis-ci.com/vacp2p/specs.svg?branch=master)](https://travis-ci.com/vacp2p/specs) +![CI](https://github.com/vacp2p/specs/workflows/CI/badge.svg) This repository contains the specs for [vac](https://vac.dev), a modular peer-to-peer messaging stack, with a focus on secure messaging. A detailed explanation of the vac and its design goals can be found [here](https://vac.dev/vac-overview). @@ -30,3 +30,15 @@ The lifecycle of the specs follows the [COSS Lifecycle](https://rfc.unprotocols. ## Meta The keywords “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt). + +## Spellcheck + +To run the spellchecker locally, you must install [pyspelling](https://facelessuser.github.io/pyspelling/). + +It can then be run with the following command: + +```console +pyspelling -c spellcheck.yml +``` + +Words that should be ignored or are unrecognized must be added to the [wordlist](./wordlist.txt). diff --git a/specs/mvds-metadata.md b/specs/mvds-metadata.md index 6dc07422..673c2ebc 100644 --- a/specs/mvds-metadata.md +++ b/specs/mvds-metadata.md @@ -17,7 +17,7 @@ redirect_from: 1. [`parents`](#parents) 2. [`ephemeral`](#ephemeral) 5. [Changelog](#changelog) -6. [Acknowledgements](#acknowledgements) +6. [Acknowledgments](#acknowledgments) 7. [Copyright](#copyright) 8. [Footnotes](#footnotes) @@ -76,7 +76,7 @@ If a message has no parents it is considered a root. There can be multiple roots ### `ephemeral` -When the `ephemeral` flag is set to `false`, a node MUST send an acknowledgement when they have received and processed a message. If it is set to `true`, it SHOULD NOT send any acknowledgement. The flag is `false` by default. +When the `ephemeral` flag is set to `false`, a node MUST send an acknowledgment when they have received and processed a message. If it is set to `true`, it SHOULD NOT send any acknowledgment. The flag is `false` by default. Nodes MAY decide to not persist ephemeral messages, however they MUST NOT be shared as part of the message history. @@ -88,7 +88,7 @@ Nodes SHOULD send ephemeral messages in batch mode. As their delivery is not nee | :-----: | ------- | | [0.1.0](https://github.com/vacp2p/specs/blob/53bc8585add58695c28cfaf4382818f4daf8de84/mdf.md) | Initial Release | -## Acknowledgements +## Acknowledgments - Andrea Maria Piana ## Copyright @@ -99,4 +99,4 @@ Copyright and related rights waived via [CC0](https://creativecommons.org/public [^1]: [^2]: Jepsen. [Causal Consistency](https://jepsen.io/consistency/models/causal). Jepsen, LLC. -[^3]: \ No newline at end of file +[^3]: diff --git a/specs/mvds.md b/specs/mvds.md index fb479383..d5c680dd 100644 --- a/specs/mvds.md +++ b/specs/mvds.md @@ -20,7 +20,7 @@ redirect_from: 3. [Retransmission](#retransmission) 5. [Formal Specification](#formal-specification) 6. [Changelog](#changelog) -7. [Acknowledgements](#acknowledgements) +7. [Acknowledgments](#acknowledgments) 8. [Copyright](#copyright) 9. [Footnotes](#footnotes) @@ -135,7 +135,7 @@ Nodes MAY have two modes with which they can send records: `BATCH` and `INTERACT

-> ***NOTE:** Batch mode is higher bandwidth whereas interactive mode is higer latency.* +> ***NOTE:** Batch mode is higher bandwidth whereas interactive mode is higher latency.* @@ -160,7 +160,7 @@ MVDS has been formally specified using TLA+: