/ 
SBOM-CycloneDX-1.03
/ SBOM::CycloneDX::ReleaseNotes

NAME

SBOM::CycloneDX::ReleaseNotes - Specifies optional release notes

SYNOPSIS

$release_notes = SBOM::CycloneDX::ReleaseNotes->new(
    type => 'major'
);

DESCRIPTION

SBOM::CycloneDX::ReleaseNotes provides the optional release notes.

METHODS

SBOM::CycloneDX::ReleaseNotes inherits all methods from SBOM::CycloneDX::Base and implements the following new ones.

SBOM::CycloneDX::ReleaseNotes->new( %PARAMS )

Properties:

  • type, The software versioning type the release note describes.

  • title, The title of the release.

  • featured_image, The URL to an image that may be prominently displayed with the release note.

  • social_image, The URL to an image that may be used in messaging on social media platforms.

  • description, A short description of the release.

  • timestamp, The date and time (timestamp) when the release note was created.

  • aliases, One or more alternate names the release may be referred to. This may include unofficial terms used by development and marketing teams (e.g. code names).

  • tags, Textual strings that aid in discovery, search, and retrieval of the associated object. Tags often serve as a way to group or categorize similar or related objects by various attributes.

  • resolves, A collection of issues that have been resolved. See SBOM::CycloneDX::Issue

  • notes, Zero or more release notes containing the locale and content. Multiple note objects may be specified to support release notes in a wide variety of languages. See SBOM::CycloneDX::Note

  • properties, Provides the ability to document properties in a name-value store. This provides flexibility to include data not officially supported in the standard without having to use additional namespaces or create extensions. Unlike key-value stores, properties support duplicate names, each potentially having different values. Property names of interest to the general public are encouraged to be registered in the CycloneDX Property Taxonomy. Formal registration is optional. See SBOM::CycloneDX::Property

$release_notes->type
$release_notes->title
$release_notes->featured_image
$release_notes->social_image
$release_notes->description
$release_notes->timestamp
$release_notes->aliases
$release_notes->tags
$release_notes->resolves
$release_notes->notes
$release_notes->properties

SUPPORT

Bugs / Feature Requests

Please report any bugs or feature requests through the issue tracker at https://github.com/giterlizzi/perl-SBOM-CycloneDX/issues. You will be notified automatically of any progress on your issue.

Source Code

This is open source software. The code repository is available for public review and contribution under the terms of the license.

https://github.com/giterlizzi/perl-SBOM-CycloneDX

git clone https://github.com/giterlizzi/perl-SBOM-CycloneDX.git

AUTHOR

  • Giuseppe Di Terlizzi <gdt@cpan.org>

LICENSE AND COPYRIGHT

This software is copyright (c) 2025 by Giuseppe Di Terlizzi.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.