Skip to content

feat!: remove deprecated CLI switches --schema-version and --outfile #892

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat!: remove deprecated CLI switches --schema-version and --outfile #892

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bf2a90d
remove switches from argparse definition
virgo-o May 4, 2025
a5375c3
remove cli switches from docs
virgo-o May 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 0 additions & 13 deletions cyclonedx_py/_internal/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,6 @@ def make_argument_parser(cls, sco: ArgumentParser, **kwargs: Any) -> ArgumentPar
action='store_true',
dest='short_purls',
default=False)
op.add_argument('--schema-version', # DEPRECATED
metavar='<version>',
help='DEPRECATED alias for option "--spec-version".',
dest='spec_version',
choices=SchemaVersion,
type=SchemaVersion.from_version,
default=SchemaVersion.V1_6.to_version())
op.add_argument('--sv', '--spec-version',
metavar='<version>',
help='Which version of CycloneDX to use.'
Expand All @@ -99,12 +92,6 @@ def make_argument_parser(cls, sco: ArgumentParser, **kwargs: Any) -> ArgumentPar
choices=OutputFormat,
type=argparse_type4enum(OutputFormat),
default=OutputFormat.JSON.name)
op.add_argument('--outfile', # DEPRECATED
metavar='<file>',
help='DEPRECATED alias for "--output-file".',
type=FileType('wt', encoding='utf8'),
dest='output_file',
default=OPTION_OUTPUT_STDOUT)
op.add_argument('-o', '--output-file',
metavar='<file>',
help='Path to the output file.'
Expand Down
12 changes: 0 additions & 12 deletions docs/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,6 @@ The full documentation can be issued by running with ``environment --help``:
(default: application)
--short-PURLs Omit all qualifiers from PackageURLs.
This causes information loss in trade-off shorter PURLs, which might improve ingesting these strings.
--schema-version <version>
DEPRECATED alias for "--spec-version"
--sv <version>, --spec-version <version>
Which version of CycloneDX to use.
{choices: 1.6, 1.5, 1.4, 1.3, 1.2, 1.1, 1.0}
Expand All @@ -94,7 +92,6 @@ The full documentation can be issued by running with ``environment --help``:
Which output format to use.
{choices: JSON, XML}
(default: JSON)
--outfile <file> DEPRECATED alias for "--output-file".
-o <file>, --output-file <file>
Path to the output file.
(set to "-" to output to STDOUT)
Expand Down Expand Up @@ -255,8 +252,6 @@ The full documentation can be issued by running with ``pipenv --help``:
(default: application)
--short-PURLs Omit all qualifiers from PackageURLs.
This causes information loss in trade-off shorter PURLs, which might improve ingesting these strings.
--schema-version <version>
DEPRECATED alias for "--spec-version"
--sv <version>, --spec-version <version>
Which version of CycloneDX to use.
{choices: 1.6, 1.5, 1.4, 1.3, 1.2, 1.1, 1.0}
Expand All @@ -268,7 +263,6 @@ The full documentation can be issued by running with ``pipenv --help``:
Which output format to use.
{choices: JSON, XML}
(default: JSON)
--outfile <file> DEPRECATED alias for "--output-file".
-o <file>, --output-file <file>
Path to the output file.
(set to "-" to output to STDOUT)
Expand Down Expand Up @@ -333,8 +327,6 @@ The full documentation can be issued by running with ``poetry --help``:
(default: application)
--short-PURLs Omit all qualifiers from PackageURLs.
This causes information loss in trade-off shorter PURLs, which might improve ingesting these strings.
--schema-version <version>
DEPRECATED alias for "--spec-version"
--sv <version>, --spec-version <version>
Which version of CycloneDX to use.
{choices: 1.6, 1.5, 1.4, 1.3, 1.2, 1.1, 1.0}
Expand All @@ -346,7 +338,6 @@ The full documentation can be issued by running with ``poetry --help``:
Which output format to use.
{choices: JSON, XML}
(default: JSON)
--outfile <file> DEPRECATED alias for "--output-file".
-o <file>, --output-file <file>
Path to the output file.
(set to "-" to output to STDOUT)
Expand Down Expand Up @@ -407,8 +398,6 @@ The full documentation can be issued by running with ``requirements --help``:
(default: application)
--short-PURLs Omit all qualifiers from PackageURLs.
This causes information loss in trade-off shorter PURLs, which might improve ingesting these strings.
--schema-version <version>
DEPRECATED alias for "--spec-version"
--sv <version>, --spec-version <version>
Which version of CycloneDX to use.
{choices: 1.6, 1.5, 1.4, 1.3, 1.2, 1.1, 1.0}
Expand All @@ -420,7 +409,6 @@ The full documentation can be issued by running with ``requirements --help``:
Which output format to use.
{choices: JSON, XML}
(default: JSON)
--outfile <file> DEPRECATED alias for "--output-file".
-o <file>, --output-file <file>
Path to the output file.
(set to "-" to output to STDOUT)
Expand Down