Skip to content

Commit

Permalink
Process2021 (#1366)
Browse files Browse the repository at this point in the history
* change h2 to id="w3c-state", support history link

* add profile detect for RY, STMT... Add rules template

* delete dummy, change test h2 to w3c-state

* add new profiles rules

* REC-track: change candidiate changes to candidate amendaments, resolves #1338

* update rules description for process 2021

* Add check https://github.com/w3c/specberus/projects/3#card-67420452, delete config noRecTrack, split config.track to REC/NOTE/RY

* Apply text changes in Process2021

* fix test

* fix test

* test

* test

* test

* test

* test

* test

* delete log

* remove unused file

* add async so we can promisify superagent's calls

* fix exception thrown when checking an old document

* fix stylesheet

* Process 2021 will be released on Nov 2

* pass API key

* add metadata test, fix shortname extraction

* fix test

* add test for metadata sameWorkAs, global replacement for process date

* give better fpwd template,change non-exist shortname

* change doc, add function sr.getDelivererGroups

* metadata: previous version. Check if there's no change of shortname as well

* upgrade node-w3capi

* fix jsdoc, use group homepage, merge group homepage check in publish.js, add check for track link

* add missing profiles to README

* fix syntax error

* implement new changes

* s/02 November/2 November/

* update assets path: s/2016/2021/

* update process text node

* CRY is Candidate Registry Snapshot

* fix group page detection

* fix test

* find GH links amongst all the links in the feedback section

* fix test

* fix test

* clear dev consoles

* status for DNOTE is DNOTE

* status for statements is STMT

* metadata for CRY should include the review date

Co-authored-by: Denis Ah-Kang <[email protected]>
Co-authored-by: Denis Ah-Kang <[email protected]>
  • Loading branch information
3 people authored Oct 29, 2021
1 parent 96c54b8 commit a31962c
Show file tree
Hide file tree
Showing 207 changed files with 35,535 additions and 1,824 deletions.
3 changes: 2 additions & 1 deletion .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
"Cmembership",
"constexpr",
"Cprocess",
"CRYD",
"ctor",
"customised",
"DAHUT",
Expand All @@ -28,6 +29,7 @@
"decltype",
"deniak",
"denicola",
"DNOTE",
"docdate",
"doctypes",
"Domenic",
Expand Down Expand Up @@ -94,7 +96,6 @@
"Pubrules",
"rdquo",
"recognising",
"rectrack",
"reprojection",
"Resc",
"retargeted",
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/node.js.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ jobs:

- name: Notify failure
uses: rectalogic/notify-irc@v1
if: failure()
if: failure() && github.event.pull_request.draft == false
with:
server: "irc.w3.org"
port: 6679
Expand Down
28 changes: 13 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,14 +154,13 @@ goals of this method).
* `delivererIDs`: ID(s) of the deliverer(s); an `Array` of `Number`s.
* `editorIDs`: ID(s) of the editor(s) responsible for the document; an `Array` of `Number`s.
* `informative`: Whether the document in informative or not.
* `rectrack`: Whether the document in on REC track or not.
* `process`: The process rules link.
* `sameWorkAs`: The previous shortlink if any.
* `implementationFeedbackDue`: The implementation review date for CRs.
* `prReviewsDue`: The review date for PRs.
* `implementationReport`: Implementation report link for CRs, PRs and RECs.
* `errata`: The errata link of the document.
* `substantiveChanges`: Whether the document is a REC and has proposed changes
* `substantiveChanges`: Whether the document is a REC and has proposed amendments
* `newFeatures`: Whether the document is a REC and has proposed additions

If some of these pieces of metadata cannot be deduced, that key will not exist, or its value will not be defined.
Expand All @@ -180,7 +179,6 @@ This is an example of the value of `Specberus.meta` after the execution of `Spec
"delivererIDs": [123, 456],
"editorIDs": [ 12345 ],
"informative": false,
"rectrack": true,
"process": "https://www.w3.org/2015/Process-20150901/" }
}
```
Expand Down Expand Up @@ -245,7 +243,6 @@ Pubrules supports advanced configs to make the validation more accurate.
| Config | Explanation |Supported value |
| ---- | ---- | ---- |
| validation | Recursively validate multipart documents | no-validation, simple-validation, recursive |
| noRecTrack | If the document is not on rec-track | true, false |
| informativeOnly | If the document is informative | true, false |
| echidnaReady |Check that the document is valid for automatic publication with Echidna | true, false|
| patentPolicy | Patent Policy version | pp2020, pp2004, pp2002 |
Expand Down Expand Up @@ -276,8 +273,7 @@ This is an example of a successful validation of a document, with profile `auto`
"links.compound",
"headers.dl" ],
"info":
[ "sotd.diff",
"structure.display-only",
[ "structure.display-only",
"structure.display-only",
"structure.display-only",
"validation.wcag" ],
Expand All @@ -291,7 +287,6 @@ This is an example of a successful validation of a document, with profile `auto`
"editorsDraft": "https://w3c.github.io/charmod-norm/",
"delivererIDs": [ 32113 ],
"editorIDs": [ 33573 ],
"rectrack": false,
"informative": false,
"process": "https://www.w3.org/2015/Process-20150901/",
"url": "https://www.w3.org/TR/2016/WD-charmod-norm-20160407/"
Expand All @@ -316,14 +311,8 @@ A profile is basically a configuration of what to check. You can load a specific
Here follows the current hierarchy of profiles. Each profile inherits all rules from its parent profile.
Profiles that are identical to its parent profile, ie that do not add any new rules, are marked too.

* `dummy`
* `base`
* `TR`
* `WG-NOTE`
* `FPWG-NOTE` (identical)
* `WG-NOTE-Echidna`
* `IG-NOTE`
* `FPIG-NOTE` (identical)
* `WD`
* `WD-Echidna`
* `FPWD` (identical)
Expand All @@ -339,6 +328,15 @@ Profiles that are identical to its parent profile, ie that do not add any new ru
* `REC-OBSOLETE`
* `REC-RSCND`
* `REC-SUPERSEDED`
* `DNOTE`
* `DNOTE-Echidna`
* `NOTE`
* `NOTE-Echidna`
* `STMT`
* `DRY`
* `CRY`
* `CRYD`
* `RY`
* `Submission`
* `SUBM`
* `MEM-SUBM`
Expand Down Expand Up @@ -384,5 +382,5 @@ The Specberus object exposes the following API that's useful for validation:
and its callback, and Specberus will conveniently take care of all the rest.
* `norm(text)`. Returns a whitespace-normalised version of the text.
* `getDocumentDate()`. Returns a Date object that matches the document's date as specified in the
headers' h2.
* `getDocumentDateElement()`. Returns the element that contains the document's date.
headers' `stateElement` (id="w3c-state").
* `getDocumentStateElement()`. Returns the element that contains the document's date.
1 change: 0 additions & 1 deletion app.js
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,6 @@ io.on('connection', socket => {
profile,
events: handler,
validation: data.validation,
noRecTrack: data.noRecTrack,
informativeOnly: data.informativeOnly,
echidnaReady: data.echidnaReady,
patentPolicy: data.patentPolicy,
Expand Down
3 changes: 0 additions & 3 deletions doc/Presentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,6 @@ In JavaScript, on [Node.js](https://nodejs.org/); with [Bootstrap](https://getbo
├── lib
│ ├── profiles
│ └── rules
│ ├── dummy
│ ├── headers
│ ├── heuristic
│ ├── links
Expand Down Expand Up @@ -100,7 +99,6 @@ In JavaScript, on [Node.js](https://nodejs.org/); with [Bootstrap](https://getbo
"FPLC"
"REC"
"LC"
"dummy"

---

Expand All @@ -119,7 +117,6 @@ In JavaScript, on [Node.js](https://nodejs.org/); with [Bootstrap](https://getbo
│ └── js
├── test
│ └── docs
│ ├── dummy
│ ├── headers
│ ├── links
│ ├── sotd
Expand Down
1 change: 0 additions & 1 deletion lib/api.js
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,6 @@ const processRequest = apiKey => (req, res) => {
);
}
options2.validation = 'simple-validation';
options2.noRecTrack = !meta.rectrack;
errors2 = [];
warnings2 = [];
info2 = [];
Expand Down
4 changes: 2 additions & 2 deletions lib/exceptions.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@
],
"^audiobooks$": [
{
"rule": "sotd.cr-end"
"rule": "sotd.candidate-review-end"
}
],
"^pub-manifest$": [
{
"rule": "sotd.cr-end"
"rule": "sotd.candidate-review-end"
}
],
"^did-core$": [
Expand Down
Loading

0 comments on commit a31962c

Please sign in to comment.