Skip to content

Commit 91cf6c6

Browse files
committed
Revert "Introduce "cyclonedx rename-entity" command (#346)"
This reverts commit f43675e.
1 parent 4c5e645 commit 91cf6c6

File tree

4 files changed

+0
-181
lines changed

4 files changed

+0
-181
lines changed

README.md

-49
Original file line numberDiff line numberDiff line change
@@ -214,55 +214,6 @@ Merge two XML formatted BOMs:
214214
Merging two BOMs and piping output to additional tools:
215215
`cyclonedx-cli merge --input-files sbom1.xml sbom2.xml --output-format json | grep "something"`
216216

217-
## Rename Entity command
218-
219-
Rename an entity identified by "bom-ref" (formally a "refType") in the document
220-
and/or back-references to such entity (formally a "refLinkType", typically as
221-
a "ref" property; or certain lists' items).
222-
223-
```
224-
rename-entity
225-
Rename an entity identified by a "bom-ref" (including back-references to it) in the BOM document
226-
227-
Usage:
228-
cyclonedx [options] rename-entity
229-
230-
Options:
231-
--input-file <input-file> Input BOM filename.
232-
--output-file <output-file> Output BOM filename, will write to stdout if no value provided.
233-
--old-ref <old-ref> Old value of "bom-ref" entity identifier (or "ref" values or certain list items pointing to it).
234-
--new-ref <new-ref> New value of "bom-ref" entity identifier (or "ref" values or certain list items pointing to it).
235-
--input-format <autodetect|json|protobuf|xml> Specify input file format.
236-
--output-format <autodetect|json|protobuf|xml> Specify output file format.
237-
```
238-
239-
Keep in mind that these identifiers are arbitrary strings that have a meaning
240-
within the Bom document (and should uniquely identify one entity in its scope).
241-
While in some cases these identifiers are meaningful (e.g. "purl" values used
242-
as "bom-ref" by the cyclonedx-maven-plugin), they may also validly be random
243-
UUIDs or collision-prone strings like "1", "2", "3"...
244-
245-
They may be opportunistically used as anchors for cross-document references,
246-
so in some cases a back-reference may point to a string for which there is no
247-
"bom-ref" in the same document (see relevant CycloneDX specification version
248-
for details).
249-
250-
This renaming operation also modifies the output document metadata, to reflect
251-
the modification compared to the input document.
252-
253-
Basic error-checking, such as attempt to re-use an already existing identifier,
254-
is performed.
255-
256-
### Examples
257-
258-
Rename an entity:
259-
```
260-
cyclonedx rename-entity --input-file sbom.json --output-format xml \
261-
--oldref "pkg:maven/org.yaml/[email protected]?type=jar" \
262-
--newref "thirdpartylibs:org.yaml:snakeyaml:1.33:jar" \
263-
| grep "thirdparty"
264-
```
265-
266217
## Sign Command
267218

268219
Sign a BOM or file

src/cyclonedx/Commands/RenameEntityCommand.cs

-101
This file was deleted.

src/cyclonedx/Commands/RenameEntityCommandOptions.cs

-30
This file was deleted.

src/cyclonedx/Program.cs

-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,6 @@ public static async Task<int> Main(string[] args)
4747
DiffCommand.Configure(rootCommand);
4848
KeyGenCommand.Configure(rootCommand);
4949
MergeCommand.Configure(rootCommand);
50-
RenameEntityCommand.Configure(rootCommand);
5150
SignCommand.Configure(rootCommand);
5251
ValidateCommand.Configure(rootCommand);
5352
VerifyCommand.Configure(rootCommand);

0 commit comments

Comments
 (0)