Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "releaseUrl" and "nightlyUrl" to "series" objects #291

Merged
merged 2 commits into from
May 5, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
- uses: actions/checkout@v1
- uses: actions/setup-node@v1
with:
node-version: 12.x
node-version: 14.x
- name: Setup environment
run: |
echo "${{ secrets.CONFIG_JSON }}" | base64 --decode > config.json
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/check-base-url.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
- name: Use Node.js 12.x
uses: actions/setup-node@v1
with:
node-version: 12.x
node-version: 14.x
- run: npm install
- run: node src/check-base-url.js # sets check_list env variable
- uses: JasonEtco/create-an-issue@v2
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
- name: Setup node.js
uses: actions/setup-node@v1
with:
node-version: 12.x
node-version: 14.x

- name: Install dependencies
run: npm ci
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/monitor-specs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Use Node.js 12.x
- name: Use Node.js 14.x
uses: actions/setup-node@v1
with:
node-version: 12.x
node-version: 14.x
- run: npm install
- run: node src/monitor-specs.js # sets review_list env variable
- uses: peter-evans/create-pull-request@v3
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/report-new-specs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Use Node.js 12.x
- name: Use Node.js 14.x
uses: actions/setup-node@v1
with:
node-version: 12.x
node-version: 14.x
- run: npm install
- run: node src/find-specs.js # sets candidate_list env variable
- uses: JasonEtco/create-an-issue@v2
Expand Down
36 changes: 35 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ cross-references, WebIDL, quality, etc.
- [`series`](#series)
- [`series.shortname`](#seriesshortname)
- [`series.currentSpecification`](#seriescurrentspecification)
- [`series.releaseUrl`](#seriesreleaseurl)
- [`series.nightlyUrl`](#seriesnightlyurl)
- [`seriesVersion`](#seriesversion)
- [`seriesComposition`](#seriescomposition)
- [`seriesPrevious`](#seriesprevious)
Expand Down Expand Up @@ -86,7 +88,9 @@ Each specification in the list comes with the following properties:
"shortTitle": "CSS Color 4",
"series": {
"shortname": "css-color",
"currentSpecification": "css-color-4"
"currentSpecification": "css-color-4",
"releaseUrl": "https://www.w3.org/TR/css-color/",
"nightlyUrl": "https://drafts.csswg.org/css-color/"
},
"seriesVersion": "4",
"seriesComposition": "full",
Expand Down Expand Up @@ -188,6 +192,36 @@ version in the series that is a "full" spec (see
The `currentSpecification` property is always set.


#### `series.releaseUrl`

The URL of the latest published snapshot for the spec series. For leveled specs
(those that create a series), this matches the unversioned URL. That
unversioned URL should return the specification identified by the
[`currentSpecification`](#seriescurrentspecification) property.

For instance, this property will be set to `https://www.w3.org/TR/css-fonts/`
for all specifications in the CSS Fonts series.

For non-leveled specs, this matches the [`url`](#url) property.

The `releaseUrl` property is only set for W3C specs published as TR documents.


#### `series.nightlyUrl`

For leveled specs (those that create a series), this matches the unversioned URL
that allows to access the latest Editor's Draft of the current specification in
the series.

For instance, this property will be set to `https://drafts.csswg.org/css-fonts/`
for all specifications in the CSS Fonts series.

For specs that are not part of a series of specs, this matches the
[`nightly.url`](#nightlyurl) property.

The `nightlyUrl` property is always set.


### `seriesVersion`

The level or version of the spec, represented as an `x`, `x.y` or `x.y.z` string
Expand Down
Loading