Merge pull request #64 from ai-cfia/63-as-a-contributor-id-like-to-ha…

…ve-the-packaging-workflow-documented

Issue #63: Document release workflow

README.md

@@ -1,8 +1,9 @@
 # fertiscan-pipeline
 
-This repository contains the core analysis pipeline for FertiScan.
-It is designed to be used as a standalone Python package that can
-be integrated with other projects, such as the [fertiscan-backend](https://github.com/ai-cfia/fertiscan-backend).
+This repository contains the core analysis pipeline for FertiScan. It is
+designed to be used as a standalone Python package that can be integrated with
+other projects, such as the
+[fertiscan-backend](https://github.com/ai-cfia/fertiscan-backend).
 
 ## Setup for Development
 
@@ -50,3 +51,21 @@ AZURE_OPENAI_API_ENDPOINT=your_azure_openai_endpoint
 AZURE_OPENAI_API_KEY=your_azure_openai_key
 AZURE_OPENAI_DEPLOYMENT=your_azure_openai_deployment
 ```
+
+## Packaging and release workflow
+
+The pipeline triggers on PRs to check code quality, markdown, repository
+standards, and ensures that the version in `pyproject.toml` is bumped. When a PR
+is merged, the workflow automatically creates a release based on the version in
+`pyproject.toml`. The latest releases and changelogs are available
+[here](https://github.com/ai-cfia/fertiscan-pipeline/releases).
+
+To use this package in other projects, add it to your `requirements.txt` (e.g.,
+in the [fertiscan-backend](https://github.com/ai-cfia/fertiscan-backend)):
+
+```sh
+git+https://github.com/ai-cfia/[email protected]
+```
+
+Where `vX.X.X` is the version from the [release
+page](https://github.com/ai-cfia/fertiscan-pipeline/releases).

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "fertiscan_pipeline"
-version = "0.0.2"
+version = "0.0.3"
 description = "A pipeline for the FertiScan project"
 authors = [
     { name = "Albert Bryan Ndjeutcha", email = "[email protected]" }