Skip to content

Commit 699c8a8

Browse files
committed
Fixed CI issues, made test chapter a bit more comprehensive
1 parent ff150b0 commit 699c8a8

File tree

4 files changed

+6
-23
lines changed

4 files changed

+6
-23
lines changed

.github/remark.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ plugins:
2121
- 'fenced'
2222
# Headings
2323
- remark-lint-heading-increment
24-
- remark-lint-no-duplicate-headings
2524
- remark-lint-no-multiple-toplevel-headings
2625
- remark-lint-no-heading-punctuation
2726
- - remark-lint-maximum-heading-length

.remarkignore

Lines changed: 0 additions & 1 deletion
This file was deleted.

README.md

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -59,40 +59,23 @@ for running tests are copied here for convenience.
5959

6060
### Running tests
6161

62-
The same check-markdown and check-examples programs that runs as a check on PR's is part of the repo and can be run locally.
62+
The same checks that run as checks on PR's are part of the repository and can be run locally to verify that changes are valid.
6363
To run tests locally, you'll need `npm`, which is a standard part of any [node.js installation](https://nodejs.org/en/download/).
64-
Alternatively, you can also use [`yarn`](https://yarnpkg.com/) instead of `npm`.
65-
In this case replace all occurrences of `npm` with `yarn` below.
6664

6765
First you'll need to install everything with npm once. Just navigate to the root of this repository and on
6866
your command line run:
69-
7067
```bash
7168
npm install
7269
```
7370

7471
Then to check markdown formatting and test the examples against the JSON schema, you can run:
75-
7672
```bash
77-
npm run test
73+
npm test
7874
```
7975

8076
This will spit out the same texts that you see online, and you can then go and fix your markdown or examples.
8177

82-
To just check the markdown run:
83-
84-
```bash
85-
npm run check-markdown
86-
```
87-
88-
To just check the examples run:
89-
90-
```bash
91-
npm run check-examples
92-
```
93-
9478
If the tests reveal formatting problems with the examples, you can fix them with:
95-
9679
```bash
9780
npm run format-examples
9881
```

examples/collection.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
{
22
"stac_version": "1.0.0-rc.1",
33
"stac_extensions": [
4-
"collection-assets",
5-
"item-assets",
4+
"https://stac-extensions.github.io/item-assets/v1.0.0/schema.json",
65
"https://stac-extensions.github.io/template/v1.0.0/schema.json"
76
],
87
"type": "Collection",
@@ -49,6 +48,9 @@
4948
},
5049
"item_assets": {
5150
"data": {
51+
"roles": [
52+
"data"
53+
],
5254
"template:new_field": "test"
5355
}
5456
},

0 commit comments

Comments
 (0)