Class ReleaseNotes

Generated

from message cyclonedx.v1_5.ReleaseNotes

Hierarchy

Constructors

Properties

aliases: string[] = []

Optional alternate names the release may be referred to. This may include unofficial terms used by development and marketing teams (e.g. code names).

Generated

from field: repeated string aliases = 7;

description?: string

A short description of the release.

Generated

from field: optional string description = 5;

featuredImage?: string

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

Generated

from field: optional string featuredImage = 3;

notes: cdx_15.Note[] = []

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

Generated

from field: repeated cyclonedx.v1_5.Note notes = 10;

properties: cdx_15.Property[] = []

Specifies optional, custom, properties

Generated

from field: repeated cyclonedx.v1_5.Property properties = 11;

resolves: cdx_15.Issue[] = []

A collection of issues that have been resolved.

Generated

from field: repeated cyclonedx.v1_5.Issue resolves = 9;

socialImage?: string

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

Generated

from field: optional string socialImage = 4;

tags: string[] = []

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

Generated

from field: repeated string tags = 8;

timestamp?: Timestamp

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

Generated

from field: optional google.protobuf.Timestamp timestamp = 6;

title?: string

The title of the release.

Generated

from field: optional string title = 2;

type: string = ""

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.

Generated

from field: string type = 1;

fields: FieldList = ...
runtime: ProtoRuntime = proto3
typeName: "cyclonedx.v1_5.ReleaseNotes" = "cyclonedx.v1_5.ReleaseNotes"

Methods

  • Compare with a message of the same type.

    Parameters

    Returns boolean

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting existing keys.

    If a message field is already present, it will be merged with the new data.

    Parameters

    • bytes: Uint8Array
    • Optional options: Partial<BinaryReadOptions>

    Returns this

  • Parse a message from a JSON value.

    Parameters

    • jsonValue: JsonValue
    • Optional options: Partial<JsonReadOptions>

    Returns this

  • Parse a message from a JSON string.

    Parameters

    • jsonString: string
    • Optional options: Partial<JsonReadOptions>

    Returns this

  • Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

    Returns MessageType<cdx_15.ReleaseNotes>

  • Serialize the message to binary data.

    Parameters

    • Optional options: Partial<BinaryWriteOptions>

    Returns Uint8Array

  • Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

    Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

    This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

    Returns JsonValue

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

  • Serialize the message to a JSON string.

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string