cyclonedx.model.release_note
============================

.. py:module:: cyclonedx.model.release_note


Classes
-------

.. autoapisummary::

   cyclonedx.model.release_note.ReleaseNotes


Module Contents
---------------

.. py:class:: ReleaseNotes(*, type: str, title: Optional[str] = None, featured_image: Optional[cyclonedx.model.XsUri] = None, social_image: Optional[cyclonedx.model.XsUri] = None, description: Optional[str] = None, timestamp: Optional[datetime.datetime] = None, aliases: Optional[collections.abc.Iterable[str]] = None, tags: Optional[collections.abc.Iterable[str]] = None, resolves: Optional[collections.abc.Iterable[cyclonedx.model.issue.IssueType]] = None, notes: Optional[collections.abc.Iterable[cyclonedx.model.Note]] = None, properties: Optional[collections.abc.Iterable[cyclonedx.model.Property]] = None)

   This is our internal representation of a `releaseNotesType` for a Component in a BOM.

   .. note::
       See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.7/xml/#type_releaseNotesType


   .. py:property:: type
      :type: str


      The software versioning type.

      It is **RECOMMENDED** that the release type use one of 'major', 'minor', 'patch', 'pre-release', or 'internal'.

      Representing all possible software release types is not practical, so standardizing on the recommended values,
      whenever possible, is strongly encouraged.

      * **major** = A major release may contain significant changes or may introduce breaking changes.
      * **minor** = A minor release, also known as an update, may contain a smaller number of changes than major
          releases.
      * **patch** = Patch releases are typically unplanned and may resolve defects or important security issues.
      * **pre-release** = A pre-release may include alpha, beta, or release candidates and typically have limited
          support. They provide the ability to preview a release prior to its general availability.
      * **internal** = Internal releases are not for public consumption and are intended to be used exclusively by the
          project or manufacturer that produced it.



   .. py:property:: title
      :type: Optional[str]


      The title of the release.



   .. py:property:: featured_image
      :type: Optional[cyclonedx.model.XsUri]


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



   .. py:property:: social_image
      :type: Optional[cyclonedx.model.XsUri]


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



   .. py:property:: description
      :type: Optional[str]


      A short description of the release.



   .. py:property:: timestamp
      :type: Optional[datetime.datetime]


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



   .. py:property:: aliases
      :type: SortedSet[str]


      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).

      Returns:
          Set of `str`



   .. py:property:: tags
      :type: SortedSet[str]


      One or more tags that may aid in search or retrieval of the release note.

      Returns:
          Set of `str`



   .. py:property:: resolves
      :type: SortedSet[IssueType]


      A collection of issues that have been resolved.

      Returns:
          Set of `IssueType`



   .. py:property:: notes
      :type: SortedSet[Note]


      Zero or more release notes containing the locale and content. Multiple note elements may be specified to support
      release notes in a wide variety of languages.

      Returns:
          Set of `Note`



   .. py:property:: properties
      :type: SortedSet[Property]


      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.

      Returns:
          Set of `Property`