feat: move output.BomRefDiscriminator to contrib.bom.utils.BomRefDiscriminator#995
feat: move output.BomRefDiscriminator to contrib.bom.utils.BomRefDiscriminator#995jkowalleck wants to merge 15 commits into
output.BomRefDiscriminator to contrib.bom.utils.BomRefDiscriminator#995Conversation
…iscriminator` Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
…iscriminator` Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
…iscriminator` Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Documentation build overview
7 files changed ·
|
…iscriminator` Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
…iscriminator` Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | -1 |
| Duplication | 0 |
🟢 Coverage 100.00% diff coverage · +0.01% coverage variation
Metric Results Coverage variation ✅ +0.01% coverage variation Diff coverage ✅ 100.00% diff coverage (80.00%) Coverage variation details
Coverable lines Covered lines Coverage Common ancestor commit (150777e) 6037 5686 94.19% Head commit (5415f26) 6050 (+13) 5699 (+13) 94.20% (+0.01%) Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch:
<coverage of head commit> - <coverage of common ancestor commit>Diff coverage details
Coverable lines Covered lines Diff coverage Pull request (#995) 42 42 100.00% Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified:
<covered lines added or modified>/<coverable lines added or modified> * 100%
NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.
There was a problem hiding this comment.
Pull request overview
Moves BomRefDiscriminator out of the core output module into cyclonedx.contrib.bom.utils, while keeping the old import path available via a deprecated re-export to avoid breaking downstream users.
Changes:
- Introduce
cyclonedx.contrib.bom.utils.BomRefDiscriminatorand addcyclonedx.contrib.bompackage init. - Update JSON/XML outputters and tests to import
BomRefDiscriminatorfrom the new contrib location. - Deprecate (but retain)
cyclonedx.output.BomRefDiscriminatoras a re-export.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| tests/test_output.py | Removes BomRefDiscriminator tests from output-focused test module. |
| tests/test_contrib_bom_utils.py | Adds tests validating BomRefDiscriminator behavior in its new contrib location. |
| tests/init.py | Updates test helper import to use new contrib path. |
| cyclonedx/output/xml.py | Switches to importing BomRefDiscriminator from cyclonedx.contrib.bom.utils. |
| cyclonedx/output/json.py | Switches to importing BomRefDiscriminator from cyclonedx.contrib.bom.utils. |
| cyclonedx/output/init.py | Removes old implementation and adds deprecated re-export wrapper for backwards compatibility. |
| cyclonedx/contrib/bom/utils.py | Adds new canonical implementation location for BomRefDiscriminator. |
| cyclonedx/contrib/bom/init.py | Adds package initializer for cyclonedx.contrib.bom. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Description
feat: move
output.BomRefDiscriminatortocontrib.bom.utils.BomRefDiscriminatorno breaking changes - old symbols are still available, but deprecated
Resolves or fixes issue:
AI Tool Disclosure
[e.g. GitHub CoPilot, ChatGPT, JetBrains Junie etc.][e.g. GPT-4.1, Claude Haiku 4.5, Gemini 2.5 Pro etc.][Summarize the key prompts or instructions given to the AI tools]Affirmation