From 8db3c422aba29e749d441c0ff53453789963f841 Mon Sep 17 00:00:00 2001 From: Victor Engmark Date: Mon, 22 Nov 2021 14:45:44 +1300 Subject: [PATCH 01/29] feat: Add Kodiak configuration --- .kodiak.toml | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 .kodiak.toml diff --git a/.kodiak.toml b/.kodiak.toml new file mode 100644 index 0000000..51806e5 --- /dev/null +++ b/.kodiak.toml @@ -0,0 +1,10 @@ +version = 1 + +[approve] +auto_approve_usernames = ["dependabot"] + +[merge] +method = "squash" + +[merge.message] +title = "pull_request_title" From a13a166300eadcca32b92b258a201eca2e73640a Mon Sep 17 00:00:00 2001 From: Victor Engmark Date: Mon, 22 Nov 2021 02:10:00 +0000 Subject: [PATCH 02/29] chore: Fix whitespace (#6) * chore: Add newline at EOF Avoids noise in diffs. * chore: Remove trailing whitespace Avoids noise in diffs. --- .github/remark.yaml | 2 +- .github/workflows/publish.yaml | 2 +- .github/workflows/test.yaml | 2 +- examples/collection.json | 2 +- examples/item.json | 2 +- json-schema/schema.json | 6 +++--- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/remark.yaml b/.github/remark.yaml index 9d1b95c..564baf8 100644 --- a/.github/remark.yaml +++ b/.github/remark.yaml @@ -37,7 +37,7 @@ plugins: - - remark-lint-unordered-list-marker-style - '-' - - remark-lint-list-item-indent - - space + - space # Tables - remark-lint-table-pipes - remark-lint-no-literal-urls diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml index 9cba42f..53220f9 100644 --- a/.github/workflows/publish.yaml +++ b/.github/workflows/publish.yaml @@ -14,4 +14,4 @@ jobs: with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: json-schema - destination_dir: ${{ env.GITHUB_REF_SLUG }} \ No newline at end of file + destination_dir: ${{ env.GITHUB_REF_SLUG }} diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 87f33a5..d44317b 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -11,4 +11,4 @@ jobs: - uses: actions/checkout@v2 - run: | npm install - npm test \ No newline at end of file + npm test diff --git a/examples/collection.json b/examples/collection.json index 0e36c98..5e7ce59 100644 --- a/examples/collection.json +++ b/examples/collection.json @@ -70,4 +70,4 @@ "rel": "item" } ] -} \ No newline at end of file +} diff --git a/examples/item.json b/examples/item.json index 06905fd..42f9ee9 100644 --- a/examples/item.json +++ b/examples/item.json @@ -64,4 +64,4 @@ "template:new_field": "test" } } -} \ No newline at end of file +} diff --git a/json-schema/schema.json b/json-schema/schema.json index d972109..5920353 100644 --- a/json-schema/schema.json +++ b/json-schema/schema.json @@ -190,9 +190,9 @@ "type": "number" } } - }, + }, "template:another_one": { - "type": "array", + "type": "array", "items": { "type": "number" } @@ -206,4 +206,4 @@ "additionalProperties": false } } -} \ No newline at end of file +} From b87045ba0936f0f4037b1533640a39d865472085 Mon Sep 17 00:00:00 2001 From: Victor Engmark Date: Mon, 22 Nov 2021 02:10:41 +0000 Subject: [PATCH 03/29] chore: Ignore IDEA configuration (#3) * chore: Add newline at EOF * chore: Order gitignores * chore: Mark node_modules as directory * chore: Ignore IDEA configuration --- .gitignore | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index b68addb..fc73c4f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ +/.idea/ +/node_modules/ /package-lock.json -/node_modules \ No newline at end of file From 87f071901ea74669c55ed9d5d7f36dafa3b5d2bc Mon Sep 17 00:00:00 2001 From: Victor Engmark Date: Thu, 25 Nov 2021 01:54:51 +0000 Subject: [PATCH 04/29] refactor: Use conditional instead of `oneOf` (#7) Since only one branch can be followed, this ensures that rather than an "is not valid under any of the given schemas" error (from jsonschema) or a bunch of errors relating to both possibilities of a `oneOf` (from ajv) the messages are as simple as if the schema only supported either items or collections. --- json-schema/schema.json | 222 +++++++++++++++++++++------------------- 1 file changed, 118 insertions(+), 104 deletions(-) diff --git a/json-schema/schema.json b/json-schema/schema.json index 5920353..c935f7a 100644 --- a/json-schema/schema.json +++ b/json-schema/schema.json @@ -3,143 +3,157 @@ "$id": "https://stac-extensions.github.io/template/v1.0.0/schema.json#", "title": "Template Extension", "description": "STAC Template Extension for STAC Items and STAC Collections.", - "oneOf": [ + "allOf": [ { - "$comment": "This is the schema for STAC Items. Remove this object if this extension only applies to Collections.", - "allOf": [ - { - "$ref": "#/definitions/stac_extensions" - }, - { - "type": "object", - "required": [ - "type", - "properties", - "assets" - ], - "properties": { - "type": { - "const": "Feature" - }, + "$ref": "#/definitions/stac_extensions" + }, + { + "if": { + "properties": { + "type": { + "const": "Feature" + } + } + }, + "then": { + "$comment": "This is the schema for STAC Items. Remove this object if this extension only applies to Collections.", + "allOf": [ + { + "$ref": "#/definitions/stac_extensions" + }, + { + "type": "object", + "required": [ + "type", + "properties", + "assets" + ], "properties": { - "allOf": [ - { - "$comment": "Require fields here for Item Properties.", - "required": [ - "template:new_field" - ] - }, - { + "properties": { + "allOf": [ + { + "$comment": "Require fields here for Item Properties.", + "required": [ + "template:new_field" + ] + }, + { + "$ref": "#/definitions/fields" + } + ] + }, + "assets": { + "$comment": "This validates the fields in Item Assets, but does not require them.", + "type": "object", + "additionalProperties": { "$ref": "#/definitions/fields" } - ] - }, - "assets": { - "$comment": "This validates the fields in Item Assets, but does not require them.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/fields" } } } - } - ] - }, - { - "$comment": "This is the schema for STAC Collections.", - "type": "object", - "allOf": [ - { - "required": [ - "type" - ], + ] + }, + "else": { + "if": { "properties": { "type": { "const": "Collection" } } }, - { - "$ref": "#/definitions/stac_extensions" - } - ], - "anyOf": [ - { - "$comment": "This is the schema for the top-level fields in a Collection. Remove this if this extension does not define top-level fields for Collections.", + "then": { + "$comment": "This is the schema for STAC Collections.", + "type": "object", "allOf": [ { - "$comment": "Require fields here for Collections (top-level).", "required": [ - "template:new_field" + "type" ] }, { - "$ref": "#/definitions/fields" + "$ref": "#/definitions/stac_extensions" } - ] - }, - { - "$comment": "This validates the fields in Collection Assets, but does not require them.", - "required": [ - "assets" ], - "properties": { - "assets": { - "type": "object", - "not": { - "additionalProperties": { + "anyOf": [ + { + "$comment": "This is the schema for the top-level fields in a Collection. Remove this if this extension does not define top-level fields for Collections.", + "allOf": [ + { + "$comment": "Require fields here for Collections (top-level).", + "required": [ + "template:new_field" + ] + }, + { + "$ref": "#/definitions/fields" + } + ] + }, + { + "$comment": "This validates the fields in Collection Assets, but does not require them.", + "required": [ + "assets" + ], + "properties": { + "assets": { + "type": "object", "not": { - "allOf": [ - { - "$ref": "#/definitions/require_any_field" - }, - { - "$ref": "#/definitions/fields" + "additionalProperties": { + "not": { + "allOf": [ + { + "$ref": "#/definitions/require_any_field" + }, + { + "$ref": "#/definitions/fields" + } + ] } - ] + } } } } - } - } - }, - { - "$comment": "This is the schema for the fields in Item Asset Definitions. It doesn't require any fields.", - "required": [ - "item_assets" - ], - "properties": { - "item_assets": { - "type": "object", - "not": { - "additionalProperties": { + }, + { + "$comment": "This is the schema for the fields in Item Asset Definitions. It doesn't require any fields.", + "required": [ + "item_assets" + ], + "properties": { + "item_assets": { + "type": "object", "not": { - "allOf": [ - { - "$ref": "#/definitions/require_any_field" - }, - { - "$ref": "#/definitions/fields" + "additionalProperties": { + "not": { + "allOf": [ + { + "$ref": "#/definitions/require_any_field" + }, + { + "$ref": "#/definitions/fields" + } + ] } - ] + } } } } + }, + { + "$comment": "This is the schema for the fields in Summaries. By default, only checks the existance of the properties, but not the schema of the summaries.", + "required": [ + "summaries" + ], + "properties": { + "summaries": { + "$ref": "#/definitions/require_any_field" + } + } } - } + ] }, - { - "$comment": "This is the schema for the fields in Summaries. By default, only checks the existance of the properties, but not the schema of the summaries.", - "required": [ - "summaries" - ], - "properties": { - "summaries": { - "$ref": "#/definitions/require_any_field" - } - } - } - ] + "else": false + } } ], "definitions": { From 7c6e44e3320e5beb8575b7e3017de76bdc79e4ba Mon Sep 17 00:00:00 2001 From: Victor Engmark Date: Mon, 29 Nov 2021 00:43:22 +0000 Subject: [PATCH 05/29] feat: Add Dependabot configuration (#2) --- .github/dependabot.yml | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 .github/dependabot.yml diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..b6eb0c1 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,10 @@ +version: 2 +updates: + - package-ecosystem: github-actions + directory: / + schedule: + interval: daily + - package-ecosystem: npm + directory: / + schedule: + interval: daily From 5ae3b47c6c8d743ef1e734854bfd0a0e091d206e Mon Sep 17 00:00:00 2001 From: Victor Engmark Date: Tue, 30 Nov 2021 02:23:43 +0000 Subject: [PATCH 06/29] feat: Add Nix shell (#5) --- shell.nix | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 shell.nix diff --git a/shell.nix b/shell.nix new file mode 100644 index 0000000..b23077c --- /dev/null +++ b/shell.nix @@ -0,0 +1,15 @@ +{ pkgs ? import + ( + fetchTarball + { + name = "21.05"; + url = "https://github.com/NixOS/nixpkgs/archive/7e9b0dff974c89e070da1ad85713ff3c20b0ca97.tar.gz"; + sha256 = "1ckzhh24mgz6jd1xhfgx0i9mijk6xjqxwsshnvq789xsavrmsc36"; + }) + { } +}: +pkgs.mkShell { + buildInputs = [ + pkgs.nodejs + ]; +} From 5fa0f3b65282b5405dbd89aaf526769405de5ee6 Mon Sep 17 00:00:00 2001 From: Victor Engmark Date: Wed, 9 Feb 2022 15:39:02 +1300 Subject: [PATCH 07/29] feat: Add editor configuration (#1) --- .editorconfig | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .editorconfig diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..3351672 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,8 @@ +# EditorConfig is awesome: https://EditorConfig.org + +[*] +charset = utf-8 +end_of_line = lf +indent_size = 2 +indent_style = space +insert_final_newline = true From 006c69e594da0ba7584983128d04a422adfa23d8 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 1 Oct 2022 09:24:20 +0000 Subject: [PATCH 08/29] chore(deps): Bump actions/setup-node from 1 to 3.5.0 (#27) Bumps [actions/setup-node](https://github.com/actions/setup-node) from 1 to 3.5.0. - [Release notes](https://github.com/actions/setup-node/releases) - [Commits](https://github.com/actions/setup-node/compare/v1...v3.5.0) --- updated-dependencies: - dependency-name: actions/setup-node dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/test.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index d44317b..7fa4f28 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -7,7 +7,7 @@ jobs: matrix: node-version: [14.x] steps: - - uses: actions/setup-node@v1 + - uses: actions/setup-node@v3.5.0 - uses: actions/checkout@v2 - run: | npm install From dd81e85cc9da3ec19e50a25f9abda6c0e960e679 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 9 Jan 2023 01:19:50 +0000 Subject: [PATCH 09/29] chore(deps): Bump actions/setup-node from 3.5.0 to 3.6.0 (#30) Bumps [actions/setup-node](https://github.com/actions/setup-node) from 3.5.0 to 3.6.0. - [Release notes](https://github.com/actions/setup-node/releases) - [Commits](https://github.com/actions/setup-node/compare/v3.5.0...v3.6.0) --- updated-dependencies: - dependency-name: actions/setup-node dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/test.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 7fa4f28..398aef2 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -7,7 +7,7 @@ jobs: matrix: node-version: [14.x] steps: - - uses: actions/setup-node@v3.5.0 + - uses: actions/setup-node@v3.6.0 - uses: actions/checkout@v2 - run: | npm install From 432721ecca0efa49ecde17bbeb2972d833feff15 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 20 Mar 2023 22:44:55 +0000 Subject: [PATCH 10/29] chore(deps): Bump remark-cli from 8.0.1 to 11.0.0 (#24) Bumps [remark-cli](https://github.com/remarkjs/remark) from 8.0.1 to 11.0.0. - [Release notes](https://github.com/remarkjs/remark/releases) - [Changelog](https://github.com/remarkjs/remark/blob/main/changelog.md) - [Commits](https://github.com/remarkjs/remark/compare/remark-cli@8.0.1...remark-cli@11.0.0) --- updated-dependencies: - dependency-name: remark-cli dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 46d280a..53937dd 100644 --- a/package.json +++ b/package.json @@ -8,7 +8,7 @@ "format-examples": "stac-node-validator . --format --schemaMap https://stac-extensions.github.io/template/v1.0.0/schema.json=./json-schema/schema.json" }, "dependencies": { - "remark-cli": "^8.0.0", + "remark-cli": "^11.0.0", "remark-lint": "^7.0.0", "remark-lint-no-html": "^2.0.0", "remark-preset-lint-consistent": "^3.0.0", From abb121584ce921ef3a1212841e5d351131b6c643 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 20 Mar 2023 22:45:26 +0000 Subject: [PATCH 11/29] chore(deps): Bump remark-validate-links from 10.0.4 to 12.1.0 (#26) Bumps [remark-validate-links](https://github.com/remarkjs/remark-validate-links) from 10.0.4 to 12.1.0. - [Release notes](https://github.com/remarkjs/remark-validate-links/releases) - [Commits](https://github.com/remarkjs/remark-validate-links/compare/10.0.4...12.1.0) --- updated-dependencies: - dependency-name: remark-validate-links dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 53937dd..e49ada9 100644 --- a/package.json +++ b/package.json @@ -14,7 +14,7 @@ "remark-preset-lint-consistent": "^3.0.0", "remark-preset-lint-markdown-style-guide": "^3.0.0", "remark-preset-lint-recommended": "^4.0.0", - "remark-validate-links": "^10.0.0", + "remark-validate-links": "^12.1.0", "stac-node-validator": "^1.0.0" } } From 44a50af227300018e63c729c39e8b112a4ed96a1 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 20 Mar 2023 22:51:10 +0000 Subject: [PATCH 12/29] chore(deps): Bump actions/checkout from 2 to 3.1.0 (#28) Bumps [actions/checkout](https://github.com/actions/checkout) from 2 to 3.1.0. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v2...v3.1.0) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/publish.yaml | 2 +- .github/workflows/test.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml index 53220f9..a1651c8 100644 --- a/.github/workflows/publish.yaml +++ b/.github/workflows/publish.yaml @@ -8,7 +8,7 @@ jobs: steps: - name: Inject env variables uses: rlespinasse/github-slug-action@v3.x - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: deploy JSON Schema for version ${{ env.GITHUB_REF_SLUG }} uses: peaceiris/actions-gh-pages@v3 with: diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 398aef2..443fbb9 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -8,7 +8,7 @@ jobs: node-version: [14.x] steps: - uses: actions/setup-node@v3.6.0 - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - run: | npm install npm test From 755542a276c7e34a470ec26ad4385b52ac150cd6 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 21 Mar 2023 01:23:20 +0000 Subject: [PATCH 13/29] chore(deps): Bump remark-preset-lint-markdown-style-guide from 3.0.1 to 5.1.2 (#18) * chore(deps): Bump remark-preset-lint-markdown-style-guide Bumps [remark-preset-lint-markdown-style-guide](https://github.com/remarkjs/remark-lint/tree/HEAD/packages/remark-preset-lint-markdown-style-guide) from 3.0.1 to 5.1.2. - [Release notes](https://github.com/remarkjs/remark-lint/releases) - [Changelog](https://github.com/remarkjs/remark-lint/blob/main/changelog.md) - [Commits](https://github.com/remarkjs/remark-lint/commits/HEAD/packages/remark-preset-lint-markdown-style-guide) --- updated-dependencies: - dependency-name: remark-preset-lint-markdown-style-guide dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] * refactor: Fix remark configuration With the original configuration, it insisted that a line like `- foo` should be changed to increase the spacing to three: > 3:3 warning Incorrect list-item indent: add 2 spaces list-item-indent remark-lint But when changed it says the opposite: > 3:5 warning Incorrect list-item indent: remove 2 spaces list-item-indent remark-lint * refactor: Fix formatting according to remark --------- Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Victor Engmark --- .github/remark.yaml | 1 - CHANGELOG.md | 2 +- README.md | 23 ++++++++++++----------- package.json | 2 +- 4 files changed, 14 insertions(+), 14 deletions(-) diff --git a/.github/remark.yaml b/.github/remark.yaml index 564baf8..3a6e878 100644 --- a/.github/remark.yaml +++ b/.github/remark.yaml @@ -37,7 +37,6 @@ plugins: - - remark-lint-unordered-list-marker-style - '-' - - remark-lint-list-item-indent - - space # Tables - remark-lint-table-pipes - remark-lint-no-literal-urls diff --git a/CHANGELOG.md b/CHANGELOG.md index dd0fd2f..21f26ba 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [Unreleased] +## [Unreleased][] ### Added diff --git a/README.md b/README.md index f5b33b2..9e6b4b0 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,21 @@ # Template Extension Specification -- **Title:** Template -- **Identifier:** -- **Field Name Prefix:** template -- **Scope:** Item, Collection -- **Extension [Maturity Classification](https://github.com/radiantearth/stac-spec/tree/master/extensions/README.md#extension-maturity):** Proposal -- **Owner**: @your-gh-handles @person2 +- foo +- **Title:** Template +- **Identifier:** +- **Field Name Prefix:** template +- **Scope:** Item, Collection +- **Extension [Maturity Classification](https://github.com/radiantearth/stac-spec/tree/master/extensions/README.md#extension-maturity):** Proposal +- **Owner**: @your-gh-handles @person2 This document explains the Template Extension to the [SpatioTemporal Asset Catalog](https://github.com/radiantearth/stac-spec) (STAC) specification. This is the place to add a short introduction. -- Examples: - - [Item example](examples/item.json): Shows the basic usage of the extension in a STAC Item - - [Collection example](examples/collection.json): Shows the basic usage of the extension in a STAC Collection -- [JSON Schema](json-schema/schema.json) -- [Changelog](./CHANGELOG.md) +- Examples: + - [Item example](examples/item.json): Shows the basic usage of the extension in a STAC Item + - [Collection example](examples/collection.json): Shows the basic usage of the extension in a STAC Collection +- [JSON Schema](json-schema/schema.json) +- [Changelog](./CHANGELOG.md) ## Item Properties and Collection Fields diff --git a/package.json b/package.json index e49ada9..9b85b19 100644 --- a/package.json +++ b/package.json @@ -12,7 +12,7 @@ "remark-lint": "^7.0.0", "remark-lint-no-html": "^2.0.0", "remark-preset-lint-consistent": "^3.0.0", - "remark-preset-lint-markdown-style-guide": "^3.0.0", + "remark-preset-lint-markdown-style-guide": "^5.1.2", "remark-preset-lint-recommended": "^4.0.0", "remark-validate-links": "^12.1.0", "stac-node-validator": "^1.0.0" From d4090e20b59764738dddd26eb33042417ae56fe5 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 21 Mar 2023 01:28:56 +0000 Subject: [PATCH 14/29] chore(deps): Bump remark-preset-lint-consistent from 3.0.1 to 5.1.1 (#17) Bumps [remark-preset-lint-consistent](https://github.com/remarkjs/remark-lint/tree/HEAD/packages/remark-preset-lint-consistent) from 3.0.1 to 5.1.1. - [Release notes](https://github.com/remarkjs/remark-lint/releases) - [Changelog](https://github.com/remarkjs/remark-lint/blob/main/changelog.md) - [Commits](https://github.com/remarkjs/remark-lint/commits/remark-preset-lint-markdown-style-guide@5.1.1/packages/remark-preset-lint-consistent) --- updated-dependencies: - dependency-name: remark-preset-lint-consistent dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 9b85b19..3659b7c 100644 --- a/package.json +++ b/package.json @@ -11,7 +11,7 @@ "remark-cli": "^11.0.0", "remark-lint": "^7.0.0", "remark-lint-no-html": "^2.0.0", - "remark-preset-lint-consistent": "^3.0.0", + "remark-preset-lint-consistent": "^5.1.1", "remark-preset-lint-markdown-style-guide": "^5.1.2", "remark-preset-lint-recommended": "^4.0.0", "remark-validate-links": "^12.1.0", From 2eb4f55f746673e08a47463cb331bdd0f6be81e5 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 21 Mar 2023 01:30:27 +0000 Subject: [PATCH 15/29] chore(deps): Bump remark-preset-lint-recommended from 4.0.1 to 6.1.2 (#16) Bumps [remark-preset-lint-recommended](https://github.com/remarkjs/remark-lint/tree/HEAD/packages/remark-preset-lint-recommended) from 4.0.1 to 6.1.2. - [Release notes](https://github.com/remarkjs/remark-lint/releases) - [Changelog](https://github.com/remarkjs/remark-lint/blob/main/changelog.md) - [Commits](https://github.com/remarkjs/remark-lint/commits/HEAD/packages/remark-preset-lint-recommended) --- updated-dependencies: - dependency-name: remark-preset-lint-recommended dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 3659b7c..ffaa48c 100644 --- a/package.json +++ b/package.json @@ -13,7 +13,7 @@ "remark-lint-no-html": "^2.0.0", "remark-preset-lint-consistent": "^5.1.1", "remark-preset-lint-markdown-style-guide": "^5.1.2", - "remark-preset-lint-recommended": "^4.0.0", + "remark-preset-lint-recommended": "^6.1.2", "remark-validate-links": "^12.1.0", "stac-node-validator": "^1.0.0" } From d09b47a0a0040167e3b7324a27feef936bc62aff Mon Sep 17 00:00:00 2001 From: Victor Engmark Date: Tue, 21 Mar 2023 14:36:04 +1300 Subject: [PATCH 16/29] fix: Don't build on push to PRs We already build on those by building on `pull_request`. --- .github/workflows/test.yaml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 443fbb9..10ce647 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -1,5 +1,9 @@ name: Check Markdown and Examples -on: [push, pull_request] +on: + pull_request: + push: + branches: + - master jobs: deploy: runs-on: ubuntu-latest From d9ac1d661691dafed586dbe441848dce1af7d7c7 Mon Sep 17 00:00:00 2001 From: Victor Engmark Date: Tue, 21 Mar 2023 14:36:16 +1300 Subject: [PATCH 17/29] feat: Enable building on request --- .github/workflows/test.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 10ce647..a067249 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -4,6 +4,7 @@ on: push: branches: - master + workflow_dispatch: jobs: deploy: runs-on: ubuntu-latest From 81c7eb608cdbd45e42ebb4fb4d51135f2712f55f Mon Sep 17 00:00:00 2001 From: Victor Engmark Date: Tue, 21 Mar 2023 14:56:21 +1300 Subject: [PATCH 18/29] fix: Use unique job names --- .github/workflows/test.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index a067249..2d01a71 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -6,7 +6,7 @@ on: - master workflow_dispatch: jobs: - deploy: + test: runs-on: ubuntu-latest strategy: matrix: From 251364ef4ed10dcfd353592bb4b69addfdf80f9d Mon Sep 17 00:00:00 2001 From: Victor Engmark Date: Tue, 21 Mar 2023 14:57:09 +1300 Subject: [PATCH 19/29] refactor: Split commands into separate steps Easier for debugging. --- .github/workflows/test.yaml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 2d01a71..4f83ac7 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -14,6 +14,5 @@ jobs: steps: - uses: actions/setup-node@v3.6.0 - uses: actions/checkout@v3 - - run: | - npm install - npm test + - run: npm install + - run: npm test From 7513f6915dcb3ebc2505ccab868d31325e06ff9f Mon Sep 17 00:00:00 2001 From: Victor Engmark Date: Tue, 21 Mar 2023 15:00:03 +1300 Subject: [PATCH 20/29] feat: Add "finalise" job Avoids a matrix, so that we don't have to change the branch protection rules every time we start using a new Node.js version. --- .github/workflows/test.yaml | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 4f83ac7..fa665b6 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -16,3 +16,14 @@ jobs: - uses: actions/checkout@v3 - run: npm install - run: npm test + finalise: + name: Verify all dependencies passed + if: always() + needs: + - test + runs-on: ubuntu-22.04 + steps: + - name: Decide whether the needed jobs succeeded or failed + uses: re-actors/alls-green@v1.2.2 + with: + jobs: ${{ toJSON(needs) }} From 1c67de9d464b31084bcae595ef9ecdebc002ba30 Mon Sep 17 00:00:00 2001 From: Victor Engmark Date: Tue, 21 Mar 2023 15:05:00 +1300 Subject: [PATCH 21/29] fix: Indentation according to `remark` --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9e6b4b0..00e01e3 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,8 @@ This document explains the Template Extension to the [SpatioTemporal Asset Catal This is the place to add a short introduction. - Examples: - - [Item example](examples/item.json): Shows the basic usage of the extension in a STAC Item - - [Collection example](examples/collection.json): Shows the basic usage of the extension in a STAC Collection + - [Item example](examples/item.json): Shows the basic usage of the extension in a STAC Item + - [Collection example](examples/collection.json): Shows the basic usage of the extension in a STAC Collection - [JSON Schema](json-schema/schema.json) - [Changelog](./CHANGELOG.md) From edd81e54be7d8ab7b7262a10a92ddfa896c26bac Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 17 Jul 2023 02:48:01 +0000 Subject: [PATCH 22/29] chore(deps): Bump actions/setup-node from 3.6.0 to 3.7.0 (#37) Bumps [actions/setup-node](https://github.com/actions/setup-node) from 3.6.0 to 3.7.0. - [Release notes](https://github.com/actions/setup-node/releases) - [Commits](https://github.com/actions/setup-node/compare/v3.6.0...v3.7.0) --- updated-dependencies: - dependency-name: actions/setup-node dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/test.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index fa665b6..aa93afe 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -12,7 +12,7 @@ jobs: matrix: node-version: [14.x] steps: - - uses: actions/setup-node@v3.6.0 + - uses: actions/setup-node@v3.7.0 - uses: actions/checkout@v3 - run: npm install - run: npm test From c138be51776ad0ed6e6bb6d2bf5f7a6efa266a61 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 17 Jul 2023 03:13:55 +0000 Subject: [PATCH 23/29] chore(deps): Bump remark-lint-no-html from 2.0.1 to 3.1.2 (#36) Bumps [remark-lint-no-html](https://github.com/remarkjs/remark-lint/tree/HEAD/packages/remark-lint-no-html) from 2.0.1 to 3.1.2. - [Release notes](https://github.com/remarkjs/remark-lint/releases) - [Changelog](https://github.com/remarkjs/remark-lint/blob/main/changelog.md) - [Commits](https://github.com/remarkjs/remark-lint/commits/HEAD/packages/remark-lint-no-html) --- updated-dependencies: - dependency-name: remark-lint-no-html dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index ffaa48c..cb00254 100644 --- a/package.json +++ b/package.json @@ -10,7 +10,7 @@ "dependencies": { "remark-cli": "^11.0.0", "remark-lint": "^7.0.0", - "remark-lint-no-html": "^2.0.0", + "remark-lint-no-html": "^3.1.2", "remark-preset-lint-consistent": "^5.1.1", "remark-preset-lint-markdown-style-guide": "^5.1.2", "remark-preset-lint-recommended": "^6.1.2", From 559bb9c593f74a4da6e45f8d150fc03967567c67 Mon Sep 17 00:00:00 2001 From: Victor Engmark Date: Mon, 17 Jul 2023 15:22:53 +1200 Subject: [PATCH 24/29] fix: Indent according to `remark` suggestions Requires a new plugin as per . --- .github/remark.yaml | 1 + README.md | 27 ++++++++++++++------------- package.json | 1 + 3 files changed, 16 insertions(+), 13 deletions(-) diff --git a/.github/remark.yaml b/.github/remark.yaml index 3a6e878..cf5cae4 100644 --- a/.github/remark.yaml +++ b/.github/remark.yaml @@ -30,6 +30,7 @@ plugins: - - remark-lint-no-shortcut-reference-link - false # Lists + - remark-gfm - remark-lint-list-item-bullet-indent - remark-lint-ordered-list-marker-style - remark-lint-ordered-list-marker-value diff --git a/README.md b/README.md index 14c9f9b..80ce2f2 100644 --- a/README.md +++ b/README.md @@ -20,11 +20,12 @@ This is the place to add a short introduction. ## Fields The fields in the table below can be used in these parts of STAC documents: -- [ ] Catalogs -- [x] Collections -- [x] Item Properties (incl. Summaries in Collections) -- [x] Assets (for both Collections and Items, incl. Item Asset Definitions in Collections) -- [ ] Links + +- [ ] Catalogs +- [x] Collections +- [x] Item Properties (incl. Summaries in Collections) +- [x] Assets (for both Collections and Items, incl. Item Asset Definitions in Collections) +- [ ] Links | Field Name | Type | Description | | -------------------- | ------------------------- | ----------- | @@ -42,20 +43,20 @@ This is a much more detailed description of the field `template:new_field`... This is the introduction for the purpose and the content of the XYZ Object... -| Field Name | Type | Description | -| ----------- | ------ | ----------- | -| x | number | **REQUIRED**. Describe the required field... | -| y | number | **REQUIRED**. Describe the required field... | -| z | number | **REQUIRED**. Describe the required field... | +| Field Name | Type | Description | +| ---------- | ------ | ----------- | +| x | number | **REQUIRED**. Describe the required field... | +| y | number | **REQUIRED**. Describe the required field... | +| z | number | **REQUIRED**. Describe the required field... | ## Relation types The following types should be used as applicable `rel` types in the [Link Object](https://github.com/radiantearth/stac-spec/tree/master/item-spec/item-spec.md#link-object). -| Type | Description | -| ------------------- | ----------- | -| fancy-rel-type | This link points to a fancy resource. | +| Type | Description | +| -------------- | ----------- | +| fancy-rel-type | This link points to a fancy resource. | ## Contributing diff --git a/package.json b/package.json index ffaa48c..78862ed 100644 --- a/package.json +++ b/package.json @@ -9,6 +9,7 @@ }, "dependencies": { "remark-cli": "^11.0.0", + "remark-gfm": "^3.0.1", "remark-lint": "^7.0.0", "remark-lint-no-html": "^2.0.0", "remark-preset-lint-consistent": "^5.1.1", From d545bcbd2c4dbc71ce210f45420baf24863e2f83 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 17 Jul 2023 03:42:54 +0000 Subject: [PATCH 25/29] chore(deps): Bump remark-lint from 7.0.1 to 9.1.2 (#35) Bumps [remark-lint](https://github.com/remarkjs/remark-lint/tree/HEAD/packages/remark-lint) from 7.0.1 to 9.1.2. - [Release notes](https://github.com/remarkjs/remark-lint/releases) - [Changelog](https://github.com/remarkjs/remark-lint/blob/main/changelog.md) - [Commits](https://github.com/remarkjs/remark-lint/commits/9.1.2/packages/remark-lint) --- updated-dependencies: - dependency-name: remark-lint dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 9af09e2..c4d65b1 100644 --- a/package.json +++ b/package.json @@ -10,7 +10,7 @@ "dependencies": { "remark-cli": "^11.0.0", "remark-gfm": "^3.0.1", - "remark-lint": "^7.0.0", + "remark-lint": "^9.1.2", "remark-lint-no-html": "^3.1.2", "remark-preset-lint-consistent": "^5.1.1", "remark-preset-lint-markdown-style-guide": "^5.1.2", From f755d2f24a76a5560612ad027c7de3270794356a Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 4 Sep 2023 22:21:28 +0000 Subject: [PATCH 26/29] chore(deps): Bump actions/checkout from 3 to 4 Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v3...v4) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- .github/workflows/publish.yaml | 2 +- .github/workflows/test.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml index a1651c8..9b19b0f 100644 --- a/.github/workflows/publish.yaml +++ b/.github/workflows/publish.yaml @@ -8,7 +8,7 @@ jobs: steps: - name: Inject env variables uses: rlespinasse/github-slug-action@v3.x - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: deploy JSON Schema for version ${{ env.GITHUB_REF_SLUG }} uses: peaceiris/actions-gh-pages@v3 with: diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 1893d06..304fdcc 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -10,7 +10,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/setup-node@v3.7.0 - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - run: npm install - run: npm test finalise: From 0fdcd21e1338346e625818cdb244194b37311439 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 25 Sep 2023 22:11:59 +0000 Subject: [PATCH 27/29] chore(deps): Bump remark-validate-links from 12.1.1 to 13.0.0 Bumps [remark-validate-links](https://github.com/remarkjs/remark-validate-links) from 12.1.1 to 13.0.0. - [Release notes](https://github.com/remarkjs/remark-validate-links/releases) - [Commits](https://github.com/remarkjs/remark-validate-links/compare/12.1.1...13.0.0) --- updated-dependencies: - dependency-name: remark-validate-links dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index c4d65b1..e8ba7c7 100644 --- a/package.json +++ b/package.json @@ -15,7 +15,7 @@ "remark-preset-lint-consistent": "^5.1.1", "remark-preset-lint-markdown-style-guide": "^5.1.2", "remark-preset-lint-recommended": "^6.1.2", - "remark-validate-links": "^12.1.0", + "remark-validate-links": "^13.0.0", "stac-node-validator": "^1.0.0" } } From 9551c386a593711da42b733b016faf97bacc41ac Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 11 Jun 2024 03:29:55 +0000 Subject: [PATCH 28/29] chore(deps): Bump peaceiris/actions-gh-pages from 3 to 4 Bumps [peaceiris/actions-gh-pages](https://github.com/peaceiris/actions-gh-pages) from 3 to 4. - [Release notes](https://github.com/peaceiris/actions-gh-pages/releases) - [Changelog](https://github.com/peaceiris/actions-gh-pages/blob/main/CHANGELOG.md) - [Commits](https://github.com/peaceiris/actions-gh-pages/compare/v3...v4) --- updated-dependencies: - dependency-name: peaceiris/actions-gh-pages dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- .github/workflows/publish.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml index 9b19b0f..4836867 100644 --- a/.github/workflows/publish.yaml +++ b/.github/workflows/publish.yaml @@ -10,7 +10,7 @@ jobs: uses: rlespinasse/github-slug-action@v3.x - uses: actions/checkout@v4 - name: deploy JSON Schema for version ${{ env.GITHUB_REF_SLUG }} - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: json-schema From aaf597cc8a1bf2c15c3da7938ba41595205d2fa5 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 11 Jun 2024 03:30:51 +0000 Subject: [PATCH 29/29] chore(deps): Bump remark-lint from 9.1.2 to 10.0.0 Bumps [remark-lint](https://github.com/remarkjs/remark-lint) from 9.1.2 to 10.0.0. - [Release notes](https://github.com/remarkjs/remark-lint/releases) - [Changelog](https://github.com/remarkjs/remark-lint/blob/main/changelog.md) - [Commits](https://github.com/remarkjs/remark-lint/compare/9.1.2...10.0.0) --- updated-dependencies: - dependency-name: remark-lint dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index e8ba7c7..28a8654 100644 --- a/package.json +++ b/package.json @@ -10,7 +10,7 @@ "dependencies": { "remark-cli": "^11.0.0", "remark-gfm": "^3.0.1", - "remark-lint": "^9.1.2", + "remark-lint": "^10.0.0", "remark-lint-no-html": "^3.1.2", "remark-preset-lint-consistent": "^5.1.1", "remark-preset-lint-markdown-style-guide": "^5.1.2",