Enums.h File Reference

This file contains all the enums used in the whole program. More...

Go to the source code of this file.

Enumerations
enum class	ReleaseNoteSources { CommitMessages , PullRequests }
enum class	ReleaseNoteModes { Short , Full }
enum class	InputErrors {   IncorrectReleaseNotesSource , NoReleaseNotesSource , IncorrectReleaseNotesMode , NoReleaseNotesMode ,   NoGithubToken , NoReleaseStartReference , NoReleaseEndReference , NoPullRequestNumber ,   NoGithubRepository }
enum class	CommitTypeInfo { ConventionalName , MarkdownTitle }
	Enumeration for all the info related to commit types. More...
enum class	CommitTypeMatchResults { MatchWithoutSubCategory , MatchWithSubCategory , NoMatch }
	Enumeration for the result of matching a commit type (e.g., fix: or fix(GUI):) against any commit type (fix, feat, etc.) More...

Detailed Description

This file contains all the enums used in the whole program.

Author

Ahmed Khaled

Enumeration Type Documentation

CommitTypeInfo

enum class CommitTypeInfo

strong

Enumeration for all the info related to commit types.

Enumerator
ConventionalName	Conventional name of the commit type (Ex: fix, feat, refactor, etc.)
MarkdownTitle	Markdown title to be displayed in the release notes section of this commit type (Ex: 🐛 Bug Fixes)

                          {
    ConventionalName, 
    MarkdownTitle 
};

CommitTypeMatchResults

enum class CommitTypeMatchResults

strong

Enumeration for the result of matching a commit type (e.g., fix: or fix(GUI):) against any commit type (fix, feat, etc.)

Enumerator
MatchWithoutSubCategory	when for example "fix:" is matched against "fix", they match and "fix:" doesn't have a subcategory "()"
MatchWithSubCategory	when for example "fix(GUI):" is matched against "fix", they match and "fix(GUI):" has a subcategory which is "GUI"
NoMatch	when for example "fix:" or "fix(GUI):" is matched against "feat", they don't match

                                  {
    MatchWithoutSubCategory, 
    MatchWithSubCategory, 
    NoMatch 
}

InputErrors

enum class InputErrors

strong

Enumerator
IncorrectReleaseNotesSource
NoReleaseNotesSource
IncorrectReleaseNotesMode
NoReleaseNotesMode
NoGithubToken
NoReleaseStartReference
NoReleaseEndReference
NoPullRequestNumber
NoGithubRepository

                       {
    IncorrectReleaseNotesSource,
    NoReleaseNotesSource,
    IncorrectReleaseNotesMode,
    NoReleaseNotesMode,
    NoGithubToken,
    NoReleaseStartReference,
    NoReleaseEndReference,
    NoPullRequestNumber,
    NoGithubRepository
};

ReleaseNoteModes

enum class ReleaseNoteModes

strong

Enumerator
Short
Full

                            {
    Short,
    Full
};

ReleaseNoteSources

enum class ReleaseNoteSources

strong

Enumerator
CommitMessages
PullRequests

                              {
    CommitMessages,
    PullRequests
};