From 9d483e240f51bc26ee6d81394445b07ea89df83d Mon Sep 17 00:00:00 2001 From: Pete Gadomski Date: Wed, 15 Mar 2023 09:42:18 -0600 Subject: [PATCH 1/2] feat: s/master/main/ for this repo Also update the PR checklist a little bit --- .github/pull_request_template.md | 7 +++---- .github/workflows/cicd.yaml | 4 ++-- .github/workflows/deploy_mkdocs.yml | 12 ++++++------ .github/workflows/packages.yml | 2 +- CHANGES.md | 2 +- README.md | 6 +++--- stac_fastapi/pgstac/README.md | 2 +- 7 files changed, 17 insertions(+), 18 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 0a245be77..25ab1b0b8 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -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). diff --git a/.github/workflows/cicd.yaml b/.github/workflows/cicd.yaml index 9bad92ba9..6f4eaddc9 100644 --- a/.github/workflows/cicd.yaml +++ b/.github/workflows/cicd.yaml @@ -1,9 +1,9 @@ name: stac-fastapi on: push: - branches: [master] + branches: [main] pull_request: - branches: [master] + branches: [main] jobs: test: diff --git a/.github/workflows/deploy_mkdocs.yml b/.github/workflows/deploy_mkdocs.yml index 00aa6ddd7..546718aab 100644 --- a/.github/workflows/deploy_mkdocs.yml +++ b/.github/workflows/deploy_mkdocs.yml @@ -3,13 +3,13 @@ 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: @@ -17,7 +17,7 @@ jobs: runs-on: ubuntu-latest steps: - - name: Checkout master + - name: Checkout main uses: actions/checkout@v3 - name: Set up Python 3.8 diff --git a/.github/workflows/packages.yml b/.github/workflows/packages.yml index 0724580f9..2267b3077 100644 --- a/.github/workflows/packages.yml +++ b/.github/workflows/packages.yml @@ -2,7 +2,7 @@ name: packages on: push: branches: - - master + - main tags: - "*" diff --git a/CHANGES.md b/CHANGES.md index da1f1f230..98e20a7f9 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -241,7 +241,7 @@ * First PyPi release! -[Unreleased]: +[Unreleased]: [2.4.4]: [2.4.3]: [2.4.2]: diff --git a/README.md b/README.md index 1fc149ee7..a05b50b1d 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Package version - + License

@@ -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: diff --git a/stac_fastapi/pgstac/README.md b/stac_fastapi/pgstac/README.md index 7961ad260..80d7fc89a 100644 --- a/stac_fastapi/pgstac/README.md +++ b/stac_fastapi/pgstac/README.md @@ -9,7 +9,7 @@ Package version - + Downloads

From 79eebb361ec53bf8d8119da625b4fb259582d5f7 Mon Sep 17 00:00:00 2001 From: Pete Gadomski Date: Wed, 15 Mar 2023 09:46:20 -0600 Subject: [PATCH 2/2] chore: update changelog --- CHANGES.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGES.md b/CHANGES.md index 98e20a7f9..fd190a4eb 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -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