Struct ReposGenerateReleaseNotesRequest

pub struct ReposGenerateReleaseNotesRequest {
    pub tag_name: String,
    pub target_commitish: Option<String>,
    pub previous_tag_name: Option<String>,
    pub configuration_file_path: Option<String>,
}

Fields

tag_name: String

The tag name for the release. This can be an existing tag or a new one.

target_commitish: Option<String>

Specifies the commitish value that will be the target for the release’s tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.

previous_tag_name: Option<String>

The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.

configuration_file_path: Option<String>

Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at ‘.github/release.yml’ or ‘.github/release.yaml’ will be used. If that is not present, the default configuration will be used.

Implementations

impl ReposGenerateReleaseNotesRequest

pub fn new(tag_name: String) -> ReposGenerateReleaseNotesRequest

Trait Implementations

impl Clone for ReposGenerateReleaseNotesRequest

fn clone(&self) -> ReposGenerateReleaseNotesRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ReposGenerateReleaseNotesRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ReposGenerateReleaseNotesRequest

fn default() -> ReposGenerateReleaseNotesRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ReposGenerateReleaseNotesRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ReposGenerateReleaseNotesRequest

fn eq(&self, other: &ReposGenerateReleaseNotesRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ReposGenerateReleaseNotesRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ReposGenerateReleaseNotesRequest