Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[OLD] use main branch instead of dev/master #268

Closed
wants to merge 2 commits into from
Closed

[OLD] use main branch instead of dev/master #268

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a0f91cc
use main branch instead of dev/master
philvarner Feb 28, 2022
fb2d706
Merge branch 'dev' into pv/migrate-dev-to-main
philvarner Mar 4, 2022
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
4 changes: 2 additions & 2 deletions .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,5 +107,5 @@ workflows:
tags:
only: /^v.*/
branches:
# Only dev branch, not PRs
only: dev
# Only main branch, not PRs
only: main
1 change: 0 additions & 1 deletion .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@

**PR Checklist:**

- [ ] This PR is made against the dev branch (all proposed changes except releases should be against dev, not master).
- [ ] This PR has **no** breaking changes.
- [ ] 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))
- [ ] 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.
19 changes: 7 additions & 12 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,19 @@ for ideas on projects to advance STAC.

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
The `main` 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. Releases are tagged. 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.

### Submitting Pull Requests

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

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

All pull requests should submit clean markdown, which is checked by the continuous integration
Expand All @@ -41,8 +39,8 @@ mistakes online, which are the same as running `npm run check` locally would sur
All pull requests that modify or create JSON schema files or examples should use
[JSON formatter](https://jsonformatter.org/) to keep files consistent across the repo.

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

### Check files

Expand Down Expand Up @@ -109,9 +107,6 @@ with a coherent whole.
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://api.stacspec.org/>
(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
Expand All @@ -131,7 +126,7 @@ vX.Y.Z-RC.1. The core STAC community should be told and encouraged to update the
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,
additional RC is needed. After there is no more changes to spec or schemas then the release process should be done on main,
with no changes to the spec - just updating the version numbers.

## Governance
Expand Down
2 changes: 1 addition & 1 deletion extensions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Please contact a STAC maintainer or open a Pull Request to add your extension to
| Name | Scope | Description | Vendor |
| -------------------------------------------------------------------------- | ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- |
| [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) |
| [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) |
| [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) |

## Creating new extensions

Expand Down