cdx-proto
    Preparing search index...

    Type Alias ReleaseNotes

    ReleaseNotes: Message<"cyclonedx.v1_5.ReleaseNotes"> & {
        aliases: string[];
        description?: string;
        featuredImage?: string;
        notes: cdx_15.Note[];
        properties: cdx_15.Property[];
        resolves: cdx_15.Issue[];
        socialImage?: string;
        tags: string[];
        timestamp?: Timestamp;
        title?: string;
        type: string;
    }

    Type declaration

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

      from field: repeated string aliases = 7;

    • Optionaldescription?: string

      A short description of the release.

      from field: optional string description = 5;

    • OptionalfeaturedImage?: string

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

      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.

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

    • properties: cdx_15.Property[]

      Specifies optional, custom, properties

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

    • resolves: cdx_15.Issue[]

      A collection of issues that have been resolved.

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

    • OptionalsocialImage?: string

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

      from field: optional string socialImage = 4;

    • tags: string[]

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

      from field: repeated string tags = 8;

    • Optionaltimestamp?: Timestamp

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

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

    • Optionaltitle?: string

      The title of the release.

      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.

      from field: string type = 1;

    from message cyclonedx.v1_5.ReleaseNotes

    Settings

    Member Visibility