Merge pull request #22 from stac-utils/pv/cleanup

rename a few targets, and fix references to them

Author: Phil Varner

.github/pull_request_template.md

@@ -1,5 +1,6 @@
-**Related Issue(s):** #
+**Related Issue(s):**
 
+- #
 
 **Description:**
 
@@ -9,4 +10,4 @@
 - [ ] Code is formatted and linted (run `pre-commit run --all-files`)
 - [ ] 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/pystac/blob/master/CHANGES.md).
+- [ ] Changes are added to the [CHANGELOG](https://github.com/stac-utils/pystac/blob/master/CHANGES.md), if applicable

.github/workflows/cicd.yaml renamed to .github/workflows/cicd.yml

@@ -11,38 +11,35 @@ run_es = docker-compose \
 	-e APP_PORT=${APP_PORT} \
 	app-elasticsearch
 
-.PHONY: es-image
-es-image:
+.PHONY: image
+image:
 	docker-compose build
 
-.PHONY: docker-run-es
-docker-run-es: es-image
+.PHONY: docker-run
+docker-run: image
 	$(run_es)
 
-.PHONY: docker-shell-es
-docker-shell-es:
+.PHONY: docker-shell
+docker-shell:
 	$(run_es) /bin/bash
 
-.PHONY: test-es
-test-es:
-	$(run_es) /bin/bash -c 'export && ./scripts/wait-for-it.sh elasticsearch:9200 && cd /app/stac_fastapi/elasticsearch/tests/ && pytest'
+.PHONY: test
+test:
+	$(run_es) /bin/bash -c 'export && ./scripts/wait-for-it-es.sh elasticsearch:9200 && cd /app/stac_fastapi/elasticsearch/tests/ && pytest'
 
-.PHONY: run-es-database
-run-es-database:
+.PHONY: run-database
+run-database:
 	docker-compose run --rm elasticsearch
 
-.PHONY: test
-test: test-elasticsearch
-
 .PHONY: pybase-install
 pybase-install:
 	pip install wheel && \
 	pip install -e ./stac_fastapi/api[dev] && \
 	pip install -e ./stac_fastapi/types[dev] && \
 	pip install -e ./stac_fastapi/extensions[dev]
 
-.PHONY: es-install
-es-install: pybase-install
+.PHONY: install
+install: pybase-install
 	pip install -e ./stac_fastapi/elasticsearch[dev,server]
 
 .PHONY: docs-image

Makefile

@@ -4,12 +4,30 @@ Elasticsearch backend for stac-fastapi.
 
 **WIP** This backend is not yet stable (notice no releases yet), so use the pgstac backend instead.
 
-------
-#### Running API on localhost:8083
+## Development Environment Setup
 
-```docker-compose up```
+Install [pre-commit](https://pre-commit.com/#install).
 
-------
-#### Testing
+Prior to commit, run:
 
-```make test-es```
+```
+pre-commit run --all-files`
+```
+
+## Building
+
+```
+docker-compose build
+```
+
+## Running API on localhost:8083
+
+```
+docker-compose up
+```
+
+## Testing
+
+```
+make test
+```