From fd8e56ce6fc698cfc9f94ab8279a48a073adffca Mon Sep 17 00:00:00 2001 From: Josh Bradley Date: Mon, 26 Aug 2024 12:28:03 -0400 Subject: [PATCH] Update developer guide (#1029) --- .../next-release/patch-20240826160100086489.json | 4 ++++ DEVELOPING.md | 12 +++++++++--- 2 files changed, 13 insertions(+), 3 deletions(-) create mode 100644 .semversioner/next-release/patch-20240826160100086489.json diff --git a/.semversioner/next-release/patch-20240826160100086489.json b/.semversioner/next-release/patch-20240826160100086489.json new file mode 100644 index 0000000000..348113b911 --- /dev/null +++ b/.semversioner/next-release/patch-20240826160100086489.json @@ -0,0 +1,4 @@ +{ + "type": "patch", + "description": "Update developer guide." +} diff --git a/DEVELOPING.md b/DEVELOPING.md index dd1763efa9..2bafd9cdcd 100644 --- a/DEVELOPING.md +++ b/DEVELOPING.md @@ -16,7 +16,7 @@ poetry install ``` -## Execute the Indexing Engine +## Executing the Indexing Engine ```sh poetry run poe index <...args> @@ -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 "." +``` + # Azurite Some unit and smoke tests use Azurite to emulate Azure resources. This can be started by running: @@ -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.