Skip to content

Commit 7eb9834

Browse files
author
Phil Varner
authored
Merge pull request #308 from philvarner/pv/dev-to-main-migration-2
Use main instead of to dev/master
2 parents 55c44d6 + ff88508 commit 7eb9834

File tree

5 files changed

+21
-18
lines changed

5 files changed

+21
-18
lines changed

.circleci/config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,5 +107,5 @@ workflows:
107107
tags:
108108
only: /^v.*/
109109
branches:
110-
# Only dev branch, not PRs
111-
only: dev
110+
# Only main branch, not PRs
111+
only: main

.github/pull_request_template.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99

1010
**PR Checklist:**
1111

12-
- [ ] This PR is made against the dev branch (all proposed changes except releases should be against dev, not master).
1312
- [ ] This PR has **no** breaking changes.
1413
- [ ] This PR does not make any changes to the core spec in the `stac-spec` directory (these are included as a subtree and should be updated directly in [radiantearth/stac-spec](https://github.com/radiantearth/stac-spec))
1514
- [ ] I have added my changes to the [CHANGELOG](https://github.com/radiantearth/stac-api-spec/blob/dev/CHANGELOG.md) **or** a CHANGELOG entry is not required.

CONTRIBUTING.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,19 @@ for ideas on projects to advance STAC.
1616

1717
The SpatioTemporal Asset Catalog API specification is under active development.
1818

19-
The `master` branch aims to always be stable, meaning that all the pieces of the specification are consistent and well
20-
explained, and all the examples are consistent with the specification. The `dev` branch is a place of active development,
21-
where a new change in one part of the spec might not yet be fully updated everywhere else. The team uses the
19+
The `main` branch is a place of active development,
20+
where a new change in one part of the spec might not yet be fully updated everywhere else. Releases are tagged. The team uses the
2221
[stac-api-spec issue tracker](https://github.com/radiantearth/stac-api-spec/issues) to identify and track all that will be done for
2322
a release. Once all the major issues are resolved the core team makes sure everything is consistent across the spec and
2423
examples.
2524

2625
### Submitting Pull Requests
2726

2827
Any proposed changes to the specification should be done as pull requests. Please make these
29-
requests against the [dev](https://github.com/radiantearth/stac-api-spec/tree/dev) branch (this will
30-
require you to switch from the default of 'master', which we keep so it displays first).
28+
requests against the [main](https://github.com/radiantearth/stac-api-spec/tree/main) branch.
3129

3230
Creating a Pull Request will show our PR template, which includes checkbox reminders for a number
33-
of things, including adding an entry the [CHANGELOG](CHANGELOG.md) and making the PR against the `dev`
31+
of things, including adding an entry the [CHANGELOG](CHANGELOG.md) and making the PR against the `main`
3432
branch.
3533

3634
All pull requests should submit clean markdown, which is checked by the continuous integration
@@ -42,7 +40,7 @@ All pull requests that modify or create JSON schema files or examples should use
4240
[JSON formatter](https://jsonformatter.org/) to keep files consistent across the repo.
4341

4442
All pull requests additionally require a review of two STAC core team members. Releases are cut
45-
from dev to master (and require 3 approvals).
43+
from main and require 3 approvals.
4644

4745
### Check files
4846

@@ -110,9 +108,6 @@ with a coherent whole.
110108
and there are no typos, errors, etc.
111109
- **Update the Changelog**: The [changelog](CHANGELOG.md) should be reviewed to make sure it includes all major improvements
112110
in the release. And anything in 'unreleased' section should move to the version of the spec to be released.
113-
- **Merge dev to master**: As there is no 'build' process, since the specification *is* the markdown files in the github
114-
repository, the key step in a release is to merge the `dev` branch into `master`, as `master` is the current stable state
115-
of the spec.
116111
- **Check Online API Docs**: Check to make sure the online API docs reflect the release at <https://api.stacspec.org/>
117112
(this step may go away once we are confident this works well, as this publishing is in flux)
118113
- **Release on Github**: The final step to create the release is to add a new 'release' on
@@ -132,7 +127,7 @@ vX.Y.Z-RC.1. The core STAC community should be told and encouraged to update the
132127
should be updated to the new specification before there is a real release. And ideally an API client is also
133128
updated. This provides the core sanity check. If there are changes or fixes to the spec or
134129
schemas needed from their feedback then make fixes and do RC2. If it is just fixes to the examples or tooling then no
135-
additional RC is needed. After there is no more changes to spec or schemas then the release process should be done on master,
130+
additional RC is needed. After there is no more changes to spec or schemas then the release process should be done on `main`,
136131
with no changes to the spec - just updating the version numbers.
137132

138133
## Governance

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,33 @@
44
# STAC API
55

66
- [STAC API](#stac-api)
7-
- [Releases](#releases)
7+
- [Releases (stable)](#releases-stable)
8+
- [Development (unstable)](#development-unstable)
89
- [About](#about)
910
- [Stability Note](#stability-note)
1011
- [Maturity Classification](#maturity-classification)
1112
- [Communication](#communication)
1213
- [In this repository](#in-this-repository)
1314
- [Contributing](#contributing)
1415

15-
## Releases
16+
## Releases (stable)
1617

17-
- [v1.0.0-rc.1](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.1)
18+
- [v1.0.0-rc.1](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.1) (latest)
1819
- [v1.0.0-beta.5](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-beta.5)
1920
- [v1.0.0-beta.4](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-beta.4)
2021
- [v1.0.0-beta.3](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-beta.3)
2122
- [v1.0.0-beta.2](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-beta.2)
2223
- [v1.0.0-beta.1](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-beta.1)
2324
- [v0.9.0](https://github.com/radiantearth/stac-api-spec/tree/v0.9.0)
2425

26+
## Development (unstable)
27+
28+
The [main](https://github.com/radiantearth/stac-api-spec/tree/main) branch in GitHub is
29+
used for active development and may be unstable. Implementers should reference one of
30+
the release branches above for a stable version of the specification.
31+
**NOTE**: This means that if you are on github.com/radiantearth/stac-api-spec then you are looking at an unreleased,
32+
unstable version of the specification. Use the first listed link on releases to read the current released, stable version
33+
of the spec.
2534
## About
2635

2736
The SpatioTemporal Asset Catalog (STAC) family of specifications aim to standardize the way geospatial asset metadata is structured and queried.

extensions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Please contact a STAC maintainer or open a Pull Request to add your extension to
8888
| Name | Scope | Description | Vendor |
8989
| -------------------------------------------------------------------------- | ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- |
9090
| [Free-text Search](https://github.com/cedadev/stac-freetext-search) | [Item Search](item-search/) request | Adds `q` parameter and free-text search against item properties | [CEDA, STFC, UKRI](https://github.com/cedadev) |
91-
| [Context Collections](https://github.com/cedadev/stac-context-collections) | [Item Search](item-search/) request | Adds a `collections` keyword to the [context](https://github.com/radiantearth/stac-api-spec/tree/master/fragments/context) extension response. | [CEDA, STFC, UKRI](https://github.com/cedadev) |
91+
| [Context Collections](https://github.com/cedadev/stac-context-collections) | [Item Search](item-search/) request | Adds a `collections` keyword to the [context](https://github.com/radiantearth/stac-api-spec/tree/main/fragments/context) extension response. | [CEDA, STFC, UKRI](https://github.com/cedadev) |
9292

9393
## Creating new extensions
9494

0 commit comments

Comments
 (0)