Skip to content

Commit

Permalink
update github ci and npm package versions (#26)
Browse files Browse the repository at this point in the history
* update github ci and npm package versions
* add gfm remark plugin

---------

Co-authored-by: Matthias Mohr <[email protected]>
  • Loading branch information
Phil Varner and m-mohr authored Oct 2, 2023
1 parent 12f9873 commit 82c71bf
Show file tree
Hide file tree
Showing 6 changed files with 32 additions and 27 deletions.
3 changes: 3 additions & 0 deletions .github/remark.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
plugins:
# GitHub Flavored Markdown
- remark-gfm
# Check links
- validate-links
# Apply some recommended defaults for consistency
Expand All @@ -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
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/publish.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ Thumbs.db
# Node / npm
.npm
/node_modules/
/package-lock.json
package-lock.json
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down
19 changes: 10 additions & 9 deletions package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand All @@ -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"
}
}

0 comments on commit 82c71bf

Please sign in to comment.