Skip to content

Commit

Permalink
Update developer guide (#1029)
Browse files Browse the repository at this point in the history
  • Loading branch information
jgbradley1 authored Aug 26, 2024
1 parent 55e74a0 commit fd8e56c
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
4 changes: 4 additions & 0 deletions .semversioner/next-release/patch-20240826160100086489.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"type": "patch",
"description": "Update developer guide."
}
12 changes: 9 additions & 3 deletions DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
poetry install
```

## Execute the Indexing Engine
## Executing the Indexing Engine

```sh
poetry run poe index <...args>
Expand All @@ -28,6 +28,13 @@ poetry run poe index <...args>
poetry run poe query <...args>
```

## Versioning

We use [semversioner](https://github.com/raulgomis/semversioner) to automate and enforce semantic versioning in the release process. Our CI/CD pipeline checks that all PR's include a json file generated by semversioner. When submitting a PR, please run:
```shell
poetry run semversioner add-change -t patch -d "<a small sentence describing changes made>."
```

# Azurite

Some unit and smoke tests use Azurite to emulate Azure resources. This can be started by running:
Expand All @@ -40,10 +47,9 @@ or by simply running `azurite` in the terminal if already installed globally. Se

# Lifecycle Scripts

Our Python package utilizes Poetry to manage dependencies and [poethepoet](https://pypi.org/project/poethepoet/) to manage build scripts.
Our Python package utilizes Poetry to manage dependencies and [poethepoet](https://pypi.org/project/poethepoet/) to manage custom build scripts.

Available scripts are:

- `poetry run poe index` - Run the Indexing CLI
- `poetry run poe query` - Run the Query CLI
- `poetry build` - This invokes `poetry build`, which will build a wheel file and other distributable artifacts.
Expand Down

0 comments on commit fd8e56c

Please sign in to comment.