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.

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

Rename default branch #544

Merged
merged 2 commits into from
Mar 16, 2023
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
7 changes: 3 additions & 4 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
**Related Issue(s):**
**Related Issue(s):**

- #

**Description:**


**PR Checklist:**

- [ ] Code is formatted and linted (run `pre-commit run --all-files`)
- [ ] `pre-commit` hooks pass locally
- [ ] Tests pass (run `make test`)
- [ ] Documentation has been updated to reflect changes, if applicable, and docs build successfully (run `make docs`)
- [ ] Changes are added to the [CHANGELOG](https://github.com/stac-utils/stac-fastapi/blob/master/CHANGES.md).
- [ ] Changes are added to the [CHANGELOG](https://github.com/stac-utils/stac-fastapi/blob/main/CHANGES.md).
4 changes: 2 additions & 2 deletions .github/workflows/cicd.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name: stac-fastapi
on:
push:
branches: [master]
branches: [main]
pull_request:
branches: [master]
branches: [main]

jobs:
test:
Expand Down
12 changes: 6 additions & 6 deletions .github/workflows/deploy_mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,21 @@ name: Publish docs via GitHub Pages
on:
push:
branches:
- master
- main
paths:
# Rebuild website when docs have changed or code has changed
- 'README.md'
- 'docs/**'
- 'mkdocs.yml'
- '**.py'
- "README.md"
- "docs/**"
- "mkdocs.yml"
- "**.py"

jobs:
build:
name: Deploy docs
runs-on: ubuntu-latest

steps:
- name: Checkout master
- name: Checkout main
uses: actions/checkout@v3

- name: Set up Python 3.8
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/packages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: packages
on:
push:
branches:
- master
- main
tags:
- "*"

Expand Down
6 changes: 5 additions & 1 deletion CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## [Unreleased]

### Changed

* Default branch to **main** ([#544](https://github.com/stac-utils/stac-fastapi/pull/544))

## [2.4.4] - 2023-03-09

### Added
Expand Down Expand Up @@ -241,7 +245,7 @@

* First PyPi release!

[Unreleased]: <https://github.com/stac-utils/stac-fastapi/compare/2.4.4..master>
[Unreleased]: <https://github.com/stac-utils/stac-fastapi/compare/2.4.4..main>
[2.4.4]: <https://github.com/stac-utils/stac-fastapi/compare/2.4.3..2.4.4>
[2.4.3]: <https://github.com/stac-utils/stac-fastapi/compare/2.4.2..2.4.3>
[2.4.2]: <https://github.com/stac-utils/stac-fastapi/compare/2.4.1..2.4.2>
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<a href="https://pypi.org/project/stac-fastapi" target="_blank">
<img src="https://img.shields.io/pypi/v/stac-fastapi.api?color=%2334D058&label=pypi%20package" alt="Package version">
</a>
<a href="https://github.com/stac-utils/stac-fastapi/blob/master/LICENSE" target="_blank">
<a href="https://github.com/stac-utils/stac-fastapi/blob/main/LICENSE" target="_blank">
<img src="https://img.shields.io/github/license/stac-utils/stac-fastapi.svg" alt="License">
</a>
</p>
Expand Down Expand Up @@ -67,11 +67,11 @@ pip install -e stac_fastapi/pgstac
### Pre-built Docker images

Pre-built images are available from the [Github Container Registry](https://github.com/stac-utils/stac-fastapi/pkgs/container/stac-fastapi).
The latest images are tagged with `master-pgstac` and `master-sqlalchemy`.
The latest images are tagged with `main-pgstac` and `main-sqlalchemy`.
To pull the image to your local system:

```shell
docker pull ghcr.io/stac-utils/stac-fastapi:master-pgstac # or latest-sqlalchemy
docker pull ghcr.io/stac-utils/stac-fastapi:main-pgstac # or main-sqlalchemy
```

This repository provides two example [Docker compose](https://docs.docker.com/compose/) files that demonstrate how you might link the pre-built images with a postgres/pgstac database:
Expand Down
2 changes: 1 addition & 1 deletion stac_fastapi/pgstac/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<a href="https://pypi.org/project/stac-fastapi" target="_blank">
<img src="https://img.shields.io/pypi/v/stac-fastapi?color=%2334D058&label=pypi%20package" alt="Package version">
</a>
<a href="https://github.com/stac-utils/stac-fastapi/blob/master/LICENSE" target="_blank">
<a href="https://github.com/stac-utils/stac-fastapi/blob/main/LICENSE" target="_blank">
<img src="https://img.shields.io/github/license/stac-utils/stac-fastapi.svg" alt="Downloads">
</a>
</p>
Expand Down