From 82c71bf6fc8f905064786fe295a4051c105f5e6b Mon Sep 17 00:00:00 2001 From: Phil Varner Date: Mon, 2 Oct 2023 09:34:13 -0400 Subject: [PATCH] update github ci and npm package versions (#26) * update github ci and npm package versions * add gfm remark plugin --------- Co-authored-by: Matthias Mohr --- .github/remark.yaml | 3 +++ .github/workflows/publish.yaml | 6 +++--- .github/workflows/test.yaml | 4 ++-- .gitignore | 2 +- README.md | 25 +++++++++++++------------ package.json | 19 ++++++++++--------- 6 files changed, 32 insertions(+), 27 deletions(-) diff --git a/.github/remark.yaml b/.github/remark.yaml index 564baf8..70dddb2 100644 --- a/.github/remark.yaml +++ b/.github/remark.yaml @@ -1,4 +1,6 @@ plugins: +# GitHub Flavored Markdown + - remark-gfm # Check links - validate-links # Apply some recommended defaults for consistency @@ -8,6 +10,7 @@ plugins: # General formatting - - remark-lint-emphasis-marker - '*' + - remark-lint-no-undefined-references - remark-lint-hard-break-spaces - remark-lint-blockquote-indentation - remark-lint-no-consecutive-blank-lines diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml index 53220f9..029974a 100644 --- a/.github/workflows/publish.yaml +++ b/.github/workflows/publish.yaml @@ -7,10 +7,10 @@ jobs: runs-on: ubuntu-latest steps: - name: Inject env variables - uses: rlespinasse/github-slug-action@v3.x - - uses: actions/checkout@v2 + uses: rlespinasse/github-slug-action@v4.4.1 + - 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@v3.9.3 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: json-schema diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index dbe73cf..0b7a055 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -4,10 +4,10 @@ jobs: deploy: runs-on: ubuntu-latest steps: - - uses: actions/setup-node@v2 + - uses: actions/setup-node@v3 with: node-version: 'lts/*' - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - run: | npm install npm test diff --git a/.gitignore b/.gitignore index 3ec698f..8ab09c2 100644 --- a/.gitignore +++ b/.gitignore @@ -9,4 +9,4 @@ Thumbs.db # Node / npm .npm /node_modules/ -/package-lock.json +package-lock.json \ No newline at end of file diff --git a/README.md b/README.md index 06ba529..bf65d0e 100644 --- a/README.md +++ b/README.md @@ -19,17 +19,18 @@ 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 -| Field Name | Type | Description | -| -------------------- | ------------------------- | ----------- | +| Field Name | Type | Description | +| -------------------- | ------------------------- | -------------------------------------------- | | template:new_field | string | **REQUIRED**. Describe the required field... | -| template:xyz | [XYZ Object](#xyz-object) | Describe the field... | -| template:another_one | \[number] | Describe the field... | +| template:xyz | [XYZ Object](#xyz-object) | Describe the field... | +| template:another_one | \[number] | Describe the field... | ### Additional Field Information @@ -41,20 +42,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 46d280a..c8eee26 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "stac-extensions", + "name": "stac-extension-template", "version": "1.0.0", "scripts": { "test": "npm run check-markdown && npm run check-examples", @@ -8,13 +8,14 @@ "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-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-recommended": "^4.0.0", - "remark-validate-links": "^10.0.0", - "stac-node-validator": "^1.0.0" + "remark-cli": "^12.0.0", + "remark-gfm": "^4.0.0", + "remark-lint": "^9.1.2", + "remark-lint-no-html": "^3.1.2", + "remark-preset-lint-consistent": "^5.1.2", + "remark-preset-lint-markdown-style-guide": "^5.1.3", + "remark-preset-lint-recommended": "^6.1.3", + "remark-validate-links": "^13.0.0", + "stac-node-validator": "^1.3.0" } }