insights-ccx-messaging

[]

Stub for all CCX services based on Insights Core Messaging framework

• Makefile targets
• Releasing a new version

Makefile targets

Available targets are:

unit_tests           Run unit tests
coverage             Run unit tests, display code coverage on terminal
coverage-report      Run unit tests, generate code coverage as a HTML report
documentation        Generate documentation for all sources
shellcheck           Run shellcheck
pyformat             Reformat all Python sources
help                 Show this help screen

Releasing a new version

The project version is derived from git tags using setuptools_scm — there is no hardcoded version file.

To create a new release:

1. Tag the desired commit on main with a lightweight tag following the vMAJOR.MINOR.PATCH convention:

   git tag v4.X.Y
   git push origin v4.X.Y

2. The CI workflow (.github/workflows/pypi-release.yaml) will automatically build and publish to PyPI.