From bbb380825ef062bf51ab418a470adccfa391eb70 Mon Sep 17 00:00:00 2001 From: Matthias Mohr Date: Fri, 9 Aug 2024 14:45:37 +0200 Subject: [PATCH] CI related updates --- .github/workflows/publish.yaml | 4 ++-- .github/workflows/test.yaml | 2 +- examples/optical-sr/item.json | 3 +-- optical.md | 16 +++++++--------- package.json | 4 ++-- 5 files changed, 13 insertions(+), 16 deletions(-) diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml index 029974a..a47c164 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@v4.4.1 + uses: rlespinasse/github-slug-action@v4 - uses: actions/checkout@v4 - name: deploy JSON Schema for version ${{ env.GITHUB_REF_SLUG }} - uses: peaceiris/actions-gh-pages@v3.9.3 + uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: json-schema diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 0b7a055..45fd78f 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -4,7 +4,7 @@ jobs: deploy: runs-on: ubuntu-latest steps: - - uses: actions/setup-node@v3 + - uses: actions/setup-node@v4 with: node-version: 'lts/*' - uses: actions/checkout@v4 diff --git a/examples/optical-sr/item.json b/examples/optical-sr/item.json index 25ec63b..1f1fd10 100644 --- a/examples/optical-sr/item.json +++ b/examples/optical-sr/item.json @@ -812,8 +812,7 @@ "https://stac-extensions.github.io/projection/v1.1.0/schema.json", "https://stac-extensions.github.io/eo/v1.1.0/schema.json", "https://stac-extensions.github.io/raster/v1.1.0/schema.json", - "https://stac-extensions.github.io/classification/v1.1.0/schema.json", - "https://stac-extensions.github.io/ceos-ard/v0.2.0/optical-sr/schema.json" + "https://stac-extensions.github.io/classification/v1.1.0/schema.json" ], "collection": "sentinel-2-l2a" } \ No newline at end of file diff --git a/optical.md b/optical.md index 3d53363..619949a 100644 --- a/optical.md +++ b/optical.md @@ -23,11 +23,7 @@ comply to the [CEOS-ARD product family specifications] (PFS) for optical sensors - Examples: - [Collection example](examples/optical-sr/collection.json): A STAC Collection for a Sentinel-2 L2A data using the STAC CEOS-ARD Optical profile - [Item example](examples/optical-sr/item.json): An examplary Item for the Sentinel-2 L2A Collection -- JSON Schema: - - [AR](json-schema/optical-ar/schema.json) (ToDo) - - [NLSR](json-schema/optical-nlsr/schema.json) (ToDo) - - [SR](json-schema/optical-sr/schema.json) (ToDo) - - [ST](json-schema/optical-st/schema.json) (ToDo) +- JSON Schema: not provided **Table of Contents:** @@ -66,7 +62,7 @@ This profile doesn't define new STAC fields, it's just a profile that uses As the identifier for this profile is just a collection of existing extensions and only defines required fields, you get a good bit of validation already without providing the identifier/schema of this profile in `stac_extensions`. If your metadata is already compliant to this profile, you can omit the identifier for this profile in -`stac_extensions` to avoid costly regeneration of the Items. You won't get validation whether all required +`stac_extensions` to avoid costly regeneration of the Items. You won't get validation whether all required fields are present, but this could be checked manually in the CEOS assessment/review. The following STAC extensions are relevant for this profile: @@ -254,7 +250,7 @@ Per-pixel metadata can be encoded in different way, for example: 2. a single file with a mask per band (requires `bands`, see [Bands] in [Common metadata]) 3. a single-band file with masks as bit-fields (requires one of the fields in the [Classification] extension) -In any way, the per-pixel metadata and its values must be clearly identifiable, e.g. by providing +In any way, the per-pixel metadata and its values must be clearly identifiable, e.g. by providing clear titles, roles, band information, bitfields, classes, and/or unit where applicable. For per-pixel metadata assets, the following properties are relavant in the context of CEOS-ARD: @@ -396,14 +392,15 @@ Excludes DEMs and DSMs, which must use [separate relation types](#accuracy) inst ### describedby -Various CEOS-ARD requirements ask for documentation about some specifics of the data. +Various CEOS-ARD requirements ask for documentation about some specifics of the data. Those links should use the relation type `describedby` and have a clear title that clearly gives information about what the link documents. Although we recommend to use `describedby` as relation type, implementors can choose to use another relation type such as `about` if it suits their implementation better. -The requested documentation can in principle all be available through a single link, +The requested documentation can in principle all be available through a single link, so you don't necessarily need to provide one link per bullet point. The following links are **required**: + - 3.2 (ST): Documentation about corrections for atmosphere and emissivity. - 3.4 (AR): Documentation about the atmospheric reflectance correction. - 3.4 (SR): Documentation about the directional atmospheric scattering algorithms. @@ -415,6 +412,7 @@ The following links are **required**: - 3.7 (AR): Documentation about other trace faseous absorption corrections. The following links are **optional**: + - 1.7 (all): Geometric Correction algorithm details. - 1.8 (all): Description of the assessed geometric accuracy of the data. - 1.11 (all): Instrument / sensor calibration parameters. diff --git a/package.json b/package.json index eda7165..b2045f9 100644 --- a/package.json +++ b/package.json @@ -4,8 +4,8 @@ "scripts": { "test": "npm run check-markdown && npm run check-examples", "check-markdown": "remark . -f -r .github/remark.yaml", - "check-examples": "stac-node-validator . --lint --verbose --schemaMap https://stac-extensions.github.io/ceos-ard/v0.2.0/schema.json=./json-schema/schema.json --schemaMap https://stac-extensions.github.io/ceos-ard/v0.2.0/optical-sr/schema.json=./json-schema/optical-sr/schema.json", - "format-examples": "stac-node-validator . --format --schemaMap https://stac-extensions.github.io/ceos-ard/v0.2.0/schema.json=./json-schema/schema.json --schemaMap https://stac-extensions.github.io/ceos-ard/v0.2.0/optical-sr/schema.json=./json-schema/optical-sr/schema.json" + "check-examples": "stac-node-validator . --lint --verbose --schemaMap https://stac-extensions.github.io/ceos-ard/v0.2.0/schema.json=./json-schema/schema.json", + "format-examples": "stac-node-validator . --format --schemaMap https://stac-extensions.github.io/ceos-ard/v0.2.0/schema.json=./json-schema/schema.json" }, "dependencies": { "remark-cli": "^12.0.0",