changelog.proto

changelog.proto

syntax = "proto3";

import "google/protobuf/timestamp.proto";

message ChangeLog {
  // Repository in form org/repo.
  string repository = 1;
  // When was an entry last added to changelog.json.
  google.protobuf.Timestamp update_time = 5;
  // Each CHANGELOG entry corresponds to a release on GitHub.
  repeated Entry entries = 1;

  enum Language {
    LANGUAGE_UNSPECIFIED = 0;
    PYTHON = 1;
    JAVA = 2;
    JAVASCRIPT = 3;
    CPP = 4;
    DOTNET = 5;
    RUBY = 6;
    PHP = 7;
    GO = 8;
  }

  message Entry {
    // The version corresponding to the release.
    string version = 1;
    // The language that the release corresponds to:
    Language language = 2;
    // The name of the artifact the release corresponds to in
    // an upstream registry.
    string artifact_name = 3;
    // A UUID v4 identifier for the release
    string id = 4;
    google.protobuf.Timestamp create_time = 5;
    // A list of individual commits that make up the release.
    repeated Change changes = 6;
  }

  message Change {
    // The Conventional Commit type of change, e.g.,
    // feat for features, fix for fixes.
    string type = 1;
    // The Conventional Commit scope of change see: conventionalcommits.org.
    optional string scope = 2;
    // Commit SHA corresponding to change.
    string sha = 3;
    // The Conventional Commit message.
    string message = 4;
    // In the case of breaking changes, the BREAKING CHANGE note.
    optional string breaking_change_note = 5;
  }
}