Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .github/remark.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ plugins:
# General formatting
- - remark-lint-emphasis-marker
- '*'
- remark-lint-no-undefined-references
- - remark-lint-no-undefined-references
- allow: ['!IMPORTANT', '!WARNING', '!NOTE', '!CAUTION', '!TIP']
- remark-lint-hard-break-spaces
- remark-lint-blockquote-indentation
- remark-lint-no-consecutive-blank-lines
Expand Down Expand Up @@ -40,7 +41,7 @@ plugins:
- - remark-lint-unordered-list-marker-style
- '-'
- - remark-lint-list-item-indent
- space
- one
# Tables
- remark-lint-table-pipes
- remark-lint-no-literal-urls
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@v4.4.1
- uses: actions/checkout@v4
uses: rlespinasse/github-slug-action@v5.6.0
- uses: actions/checkout@v7
- name: deploy JSON Schema for version ${{ env.GITHUB_REF_SLUG }}
uses: peaceiris/actions-gh-pages@v3.9.3
uses: peaceiris/actions-gh-pages@v4.1.0
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@v3
- uses: actions/setup-node@v6
with:
node-version: 'lts/*'
- uses: actions/checkout@v4
- uses: actions/checkout@v7
- run: |
npm install
npm test
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Changelog

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/),
Expand All @@ -16,4 +17,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Fixed

[Unreleased]: <https://github.com/stac-extensions/template/compare/v1.0.0...HEAD>
[Unreleased]: <https://github.com/stac-extensions/template/compare/v0.1.0...HEAD>
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
# Template Extension Specification

- **Title:** Template
- **Identifier:** <https://stac-extensions.github.io/template/v1.0.0/schema.json>
- **Identifier:** <https://stac-extensions.github.io/template/v0.1.0/schema.json>
- **Field Name Prefix:** template
- **Scope:** Item, Collection
- **Scope:** Catalog, Collection, Item
Comment thread
m-mohr marked this conversation as resolved.
- **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:
Expand All @@ -20,11 +21,12 @@ This is the place to add a short introduction.

The fields in the table below can be used in these parts of STAC documents:

- [ ] Catalogs
- [x] Catalogs
- [x] Collections
- [x] Item Properties (incl. Summaries in Collections)
- [x] Assets (for both Collections and Items, incl. Item Asset Definitions in Collections)
- [ ] Links
- [x] Assets (for both Collections and Items, incl. Item Asset Definitions in Collections and Asset Templates)
- [x] Links (incl. Link Templates)
- [x] Bands

| Field Name | Type | Description |
| -------------------- | ------------------------- | -------------------------------------------- |
Expand Down Expand Up @@ -67,23 +69,26 @@ for running tests are copied here for convenience.

### Running tests

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.
The same checks that run as checks on PRs are part of the repository and can be run locally to verify that changes are valid.
To run tests locally, you'll need `npm`, which is a standard part of any [node.js installation](https://nodejs.org/en/download/).

First you'll need to install everything with npm once. Just navigate to the root of this repository and on
First you'll need to install everything with npm once. Just navigate to the root of this repository and on
your command line run:

```bash
npm install
```

Then to check markdown formatting and test the examples against the JSON schema, you can run:

```bash
npm test
```

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

If the tests reveal formatting problems with the examples, you can fix them with:

```bash
npm run format-examples
```
5 changes: 2 additions & 3 deletions examples/collection.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
{
"stac_version": "1.0.0",
"stac_version": "1.1.0",
"stac_extensions": [
"https://stac-extensions.github.io/item-assets/v1.0.0/schema.json",
"https://stac-extensions.github.io/template/v1.0.0/schema.json"
"https://stac-extensions.github.io/template/v0.1.0/schema.json"
],
"type": "Collection",
"id": "collection",
Expand Down
4 changes: 2 additions & 2 deletions examples/item.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"stac_version": "1.0.0",
"stac_version": "1.1.0",
"stac_extensions": [
"https://stac-extensions.github.io/template/v1.0.0/schema.json"
"https://stac-extensions.github.io/template/v0.1.0/schema.json"
],
"type": "Feature",
"id": "item",
Expand Down
Loading