-
Notifications
You must be signed in to change notification settings - Fork 52
Updates for relative links and being clear on version dependencies #65
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
c750f38
added note on using submodule
cholmes 4c8821f
Merge branch 'master' into lock-version
cholmes 5b09923
updates to inform about STAC Core versions
cholmes 0898245
updates for relative links
cholmes be475c2
copied PROCESS.md from stac-spec, tweaked for stac-api-spec, and adde…
cholmes 44d3e1d
markdown fixes
cholmes 23f8619
forgot an s
cholmes 1c72ec6
updated changelog, per suggestion in PR review
cholmes File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
## STAC Development & Release Process | ||
|
||
### Development Process | ||
|
||
The SpatioTemporal Asset Catalog API specification is under active development. | ||
|
||
The `master` branch aims to always be stable, meaning that all the pieces of the specification are consistent and well | ||
explained, and all the examples are consistent with the specification. The `dev` branch is a place of active development, | ||
where a new change in one part of the spec might not yet be fully updated everywhere else. The team uses the | ||
[stac-api-spec issue tracker](https://github.com/radiantearth/stac-api-spec/issues) to identify and track all that will be done for | ||
a release. Once all the major issues are resolved the core team makes sure everything is consistent across the spec and | ||
examples. | ||
|
||
Any changes to the spec must be made as pull requests to the `dev` branch. Anyone is welcome and encouraged to bring ideas | ||
and improvements, to the issue tracker or (ideally) as pull requests. To merge a new pull request the work must be reviewed | ||
by at least two members of the STAC spec core team (who have write access to the main repository). It also must pass the | ||
Continuous Integration testing. | ||
|
||
### Release Process | ||
|
||
To release a new version of the STAC spec the following list of tasks must be done. | ||
|
||
- **Update Issue Tracker**: Each release has a [milestone](https://github.com/radiantearth/stac-spec/milestones) in the github | ||
issue tracker, and before a release is done all open issues that are filed against it should be reviewed. All issues do not | ||
need to be completed, but the core release team should all review the issues to make sure that the critical ones for the | ||
release have been addressed. Issues that aren't seen as essential should be moved to future releases, so that there are no | ||
open issues against the milestone. | ||
- **Check dependencies**: STAC relies on OGC API - Features and STAC Core specifications at its core, and will likely rely | ||
on additional Features API extensions as well as OGC API - Commons. We aim to always reference the latest version of these, | ||
so before releasing we should check to make sure we are on the latest stable versions, and upgrade if it makes sense. We include | ||
the latest stable STAC core spec version as a 'submodule', so before release we should update that to be the latest. | ||
- **Agreement from core team**: The core STAC API team should meet (on video or on gitter) and decided that the release is ready. | ||
This should include review of the issues, as well as looking at the spec holistically, to make sure the new changes keep | ||
with a coherent whole. | ||
- **Final Spec Read Through**: There should be a final read through of the core specification to make sure it makes sense | ||
and there are no typos, errors, etc. | ||
- **Update the Changelog**: The [changelog](CHANGELOG.md) should be reviewed to make sure it includes all major improvements | ||
in the release. And anything in 'unreleased' section should move to the version of the spec to be released. | ||
- **Merge dev to master**: As there is no 'build' process, since the specification *is* the markdown files in the github | ||
repository, the key step in a release is to merge the `dev` branch into `master`, as `master` is the current stable state | ||
of the spec. | ||
- **Check Online API Docs**: Check to make sure the online API docs reflect the release at <https://stacspec.org/STAC-api.html> | ||
and <https://stacspec.org/STAC-ext-api.html> (this step may go away once we are confident this works well, as this publishing is in flux) | ||
- **Release on Github**: The final step to create the release is to add a new 'release' on | ||
<https://github.com/radiantearth/stac-spec/releases>. This should use a tag like the others, with a 'v' prefix and then the | ||
release number, like v0.5.2. The changelog should be copied over to be the release notes, and then also include a link to | ||
the full milestone of everything closed in the issue tracker. | ||
- **Promote the release**: A blog post and tweet should be composed and sent out, and then inform those in the gitter channel | ||
to post / promote it. | ||
|
||
#### Release Candidates | ||
|
||
Before any release that has *major* changes (made as a judgement call by the core contributors) there should be a 'release | ||
candidate' to ensure the wider community of implementors can try it out | ||
and catch any errors *before* a full release. It is only through actual implementations that we can be sure the new spec | ||
version is good, so this step is essential if there are major changes. The release should proceed as normal, but called | ||
vX.Y.Z-RC.1. The core STAC community should be told and encouraged to update their implementations. At least 2 implementations | ||
should be updated to the new specification before there is a real release. And ideally an API client is also | ||
updated. This provides the core sanity check. If there are changes or fixes to the spec or | ||
schemas needed from their feedback then make fixes and do RC2. If it is just fixes to the examples or tooling then no | ||
additional RC is needed. After there is no more changes to spec or schemas then the release process should be done on master, | ||
with no changes to the spec - just updating the version numbers. | ||
|
||
### Governance | ||
|
||
The goal of STAC is to have a Project Steering Committee of core contributors, representing diverse organizations and | ||
implementations. To bootstrap Chris Holmes is the Benevolent Dictator for | ||
Life or until a PSC is formed, so we don't get stuck waiting for votes when there is not enough activity. | ||
|
||
The longer term goal is to contribute STAC spec to the Open Geospatial Consortium, and indeed to align as much as possible | ||
with their next generation spec. The current plan is to contribute STAC API as an OGC 'community module' when we reach | ||
1.0.0, and to work to have it become part of the OGC API baseline. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,16 +8,16 @@ The SpatioTemporal Asset Catalog (STAC) specification aims to standardize the wa | |
A 'spatiotemporal asset' is any file that represents information about the earth captured in a certain space and | ||
time. The core STAC specification lives at [gitub.com/radiantearth/stac-spec](https://github.com/radiantearth/stac-spec). | ||
|
||
A STAC API is the dynamic version of a SpatioTemporal Asset Catalog. It returns a STAC [Catalog](https://github.com/radiantearth/stac-spec/catalog-spec/catalog-spec.md), | ||
[Collection](https://github.com/radiantearth/stac-spec/collection-spec/collection-spec.md), [Item](https://github.com/radiantearth/stac-spec/item-spec/item-spec.md), | ||
A STAC API is the dynamic version of a SpatioTemporal Asset Catalog. It returns a STAC [Catalog](stac-spec/catalog-spec/catalog-spec.md), | ||
[Collection](stac-spec/collection-spec/collection-spec.md), [Item](stac-spec/item-spec/item-spec.md), | ||
or ItemCollection, depending on the endpoint. | ||
Catalogs and Collections are JSON, while Items and ItemCollections are GeoJSON-compliant entities with foreign members. | ||
Typically, a Feature is used when returning a single Item, and FeatureCollection when multiple Items (rather than a JSON array of Item entities). | ||
|
||
The API is compliant with the *[OGC API - Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html)* standard | ||
(formerly known as *OGC Web Feature Service 3*), in that it defines many of the endpoints that STAC uses. A STAC API should be | ||
compatible and usable with any OGC API - Features clients. The STAC API can be thought of as a specialized Features API | ||
to search STAC Catalogs, where the features returned are STAC [Items](https://github.com/radiantearth/stac-spec/item-spec/item-spec.md), | ||
to search STAC Catalogs, where the features returned are STAC [Items](stac-spec/item-spec/item-spec.md), | ||
that have common properties, links to their assets and geometries that represent the footprints of the geospatial assets. | ||
|
||
## Stability Note | ||
|
@@ -51,6 +51,12 @@ Human-readable versions of the OpenAPI definitions can be viewed online for the | |
- [Only the core STAC API](https://stacspec.org/STAC-api.html) | ||
- [STAC API including all extensions](https://stacspec.org/STAC-ext-api.html) | ||
|
||
**STAC Core Spec:** This repository includes a '[sub-module](https://git-scm.com/book/en/v2/Git-Tools-Submodules)', which | ||
is a copy of the [STAC Core Spec](stac-spec/) tagged at the latest stable version. This allows | ||
us to refer to the core spec with relative links. Sub-modules aren't checked out by default, so to get the directory | ||
populated either use `git submodule update --init --recursive` if you've already cloned it, or clone from the start with | ||
`git clone --recursive [email protected]:radiantearth/stac-api-spec.git`. | ||
|
||
## OpenAPI definitions | ||
|
||
The definitive specification for STAC API is provided as an [OpenAPI](http://openapis.org/) 3.0 specification that is | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm wondering whether we should have a central place for things that are common across stac-spec and stac-api-spec. It's always a pain to keep things aligned...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm open to it, but not sure how it would work. I feel like it either is harder for a new user to understand (go look at this repo to find out x, y & z), or it's some complicated technical thing (though maybe submodules come close)?
I sorta figured the release processes would also diverge some.