Config.h

Go to the documentation of this file.

 
#pragma once
 
#include <string>
 
using namespace std;
 
class Config {
public:
    string markdownOutputFileName;
    string htmlOutputFileName;
    string githubUrl;
    string githubReposApiUrl;
    string githubMarkdownApiUrl;
    string repoIssuesUrl;
    string repoCommitsUrl;
    string repoPullRequestsApiUrl;
    int commitTypesCount;
    string commitTypes[50][2];
    // Variables that determine the syntax of running the script
    // To generate release notes directly from the CLI using commit messages as source
    // ./release_notes_generator commitMessagesSourceCliInputName release_start_reference release_end_reference github_token
    // To generate release notes from the inputs of the GitHub Actions workflow using commit messages as source
    // ./release_notes_generator commitMessagesSourceGithubActionsInputName release_start_reference release_end_reference github_token
    // Same thing with editing the syntax of running the script with pull requests as source and the syntax of the 2 modes related to it (short/full)
    string commitMessagesSourceCliInputName;
    string commitMessagesSourceGithubActionsInputName;
    string pullRequestsSourceCliInputName;
    string pullRequestsSourceGithubActionsInputName;
    string shortModeCliInputName;
    string shortModeGithubActionsInputName;
    string fullModeCliInputName;
    string fullModeGithubActionsInputName;
    string singlePullRequestSourceCliInputName;
 
    // Variables that determine the looks of the release notes
    string markdownReleaseNotePrefix;
    string markdownFullModeReleaseNotePrefix;
 
    // Variables that control the output messages that are shown to the user
    string noReleaseNotesSourceError;
    string incorrectReleaseNotesSourceError;
    string noReleaseNotesModeError;
    string incorrectReleaseNotesModeError;
    string noGithubTokenError;
    string noReleaseStartReferenceError;
    string noReleaseEndReferenceError;
    string noPullRequestNumberError;
    string noGithubRepositoryError;
    string githubApiRateLimitExceededError;
    string githubApiUnauthorizedAccessError;
    string githubApiBadRequestError;
    string githubApiUnableToMakeRequestError;
    string githubApiLibcurlError;
    string gitLogError;
    string markdownFileError;
    string htmlFileError;
    string expectedSyntaxMessage;
    string generatingReleaseNotesMessage;
    string failedToGenerateReleaseNotesMessage;
    string emptyReleaseNotesMessage;
 
    void load(const string& configFileName);
};