Skip to content
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.

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

CLI comand via CycloneDX:make-sbom #309

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/ValidationError-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ assignees: ''
Steps to reproduce the behavior:

1. How was _cyclonedx-php-composer_ called?
<!-- e.g. `composer make-bom --exclude-dev ...` -->
<!-- e.g. `composer CycloneDX:make-sbom --exclude-dev ...` -->
2. What `composer.lock` file was processed?
<!-- upload it to this issue, or a pastebin of you choice and put the link here. -->
3. Error report:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/demo.yml
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ jobs:
if: ${{ ! matrix.stdout }}
working-directory: ${{ env.DEMO_TOOL_PATH }}
run: >
composer make-bom
composer CycloneDX:make-sbom
-vvv
$OMIT_RULES
--spec-version=${{ matrix.spec-version }}
Expand All @@ -156,7 +156,7 @@ jobs:
if: ${{ matrix.stdout }}
working-directory: ${{ env.DEMO_TOOL_PATH }}
run: >
composer make-bom
composer CycloneDX:make-sbom
-vvv
$OMIT_RULES
--spec-version=${{ matrix.spec-version }}
Expand Down
3 changes: 3 additions & 0 deletions HISTORY.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ All notable changes to this project will be documented in this file.
* Removed support for PHP `<8.1` (via [#250])
* Removed support for Composer `<2.3` ([#153] via [#250])
* CLI
* Removed deprecated composer command `make-bom`, call `composer CycloneDX:make-sbom` instead ([#293] via [#309])
* Changed option `output-file` to default to `-` now, which causes to print to STDOUT (via [#250])
* Removed option `exclude-dev` in favour of new option `omit` (via [#250])
* Removed option `exclude-plugins` in favour of new option `omit` (via [#250])
Expand Down Expand Up @@ -45,6 +46,8 @@ All notable changes to this project will be documented in this file.
[#250]: https://github.com/CycloneDX/cyclonedx-php-composer/pull/250
[#261]: https://github.com/CycloneDX/cyclonedx-php-composer/issues/261
[#279]: https://github.com/CycloneDX/cyclonedx-php-composer/issues/279
[#293]: https://github.com/CycloneDX/cyclonedx-php-composer/issues/293
[#309]: https://github.com/CycloneDX/cyclonedx-php-composer/pull/309

## 3.10.2 - 2022-09-15

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,15 @@ composer require --dev cyclonedx/cyclonedx-php-composer

## Usage

After successful installation, the composer command `make-bom` is available.
After successful installation, the composer command `CycloneDX:make-sbom` is available.

```text
$ composer make-bom --help
$ composer CycloneDX:make-sbom --help
Description:
Generate a CycloneDX Bill of Materials from a PHP composer project.

Usage:
make-bom [options] [--] [<composer-file>]
CycloneDX:make-sbom [options] [--] [<composer-file>]

Arguments:
composer-file Path to composer config file.
Expand Down
2 changes: 1 addition & 1 deletion src/Plugin.php
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ public function getCommands(): array
return [
new MakeBom\Command(
new MakeBom\Options(),
'make-bom'
'CycloneDX:make-sbom'
),
];
}
Expand Down
2 changes: 1 addition & 1 deletion tests/PluginTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ public function testMakeBomCommandIsRegistered(CommandProvider $commandProvider)
self::assertCount(1, $commands);
$command = reset($commands);
self::assertInstanceOf(Command::class, $command);
self::assertSame('make-bom', $command->getName());
self::assertSame('CycloneDX:make-sbom', $command->getName());
}

#[\PHPUnit\Framework\Attributes\Depends('testPluginImplementsRequiredInterfaces')]
Expand Down