GitHub - EurekaLog Documentation

This is setup options for GitHub send method (wsmGitHub). They are located at Sending tab.

GitHub send method options

Important: GitHub does not support file attaches. Be sure to create "eurekalog_reports" branch to store bug report files.

1. "URL" (.SendGitHubURL) option specifies target URL for your GitHub installation. Do not add here "http://" or ":80" parts here. Specify only domain name (or IP) and path. Example: github.com/

2. "Port" (.SendGitHubPort) option specifies HTTP port on web server. It's 80 by default. Other common value is 8080. For SSL/TLS it's usually 443. Port will be set automatically to 80/443 by default.

3. "SSL / TLS" (.SendGitHubSSL) option enabled secure mode (HTTPS protocol). Port will be set automatically to 80/443 by default. Don't forget to adjust port number, if you are using an alternative port number.

4. "Repo owner" (.SendGitHubLogin) option specifies repository owner on GitHub server. "Project" option (see below) specifies repository, which should belong to this account.

Notes:

•	It may or may not be the same account as account for access token (see below);

•	It is optional. If you do not specify account - then account for your token will be used

5. "Token" (.SendGitHubPassword) option specifies your account on GitHub server. This account will be used to submit bug reports. You can create a new API Key in your GitHub project profile.

Warning: your real account's data will be stored inside application. Even if it's encrypted - it's still stored inside .exe, so it can be stolen. See also: GitHub setup, Security Considerations.

6. "Proxy" (.SendGitHubProxyHost, .SendGitHubProxyPort, .SendGitHubProxyLogin, .SendGitHubProxyPassword) options specify proxy details. You can leave them blank to use system-provided settings. Or you can fill these values to set custom proxy.

7. "Connect" button will try to connect to your GitHub server using the specified URL/port/credentials. If you made a mistake in your configuration - an error message will be displayed. In case of success - field below will be populated from configuration of your bug tracker.

8. "Project" (.SendGitHubProject) options specifies repository name to store bug reports. It's mandatory. Project name is case-insensitive.

Notes:

•	Repository must belong to the user account specified as "Repo owner" option;

•	If "Repo owner" option is not specified - then repository owner is assumed to be account with access token.

9. "Opened statuses" (.SendGitHubOpenedStatuses) option specifies which statuses indicate that issue is NEW. The list can contain one of more values. Separate individual values with semicolon (";"). This option is case insensitive.

See also: issues workflow.

11. "Add environment to labels" (.SendGitHubUseEnvironment) option instructs EurekaLog to use add store PC and OS information in labels for the issue. Disable this option to disable this behavior. Please note that EurekaLog will still fill a minimal amount of information to labels (such as BugID).

12. "Post bugs only for released builds" (.SendGitHubUseVersion) option instructs EurekaLog to check released versions ("tags") before posting a new issue. Disable this option to always post bugs regardless of version of your application.

Notes:

•	You must enter valid versions into GitHub's configuration. You also need to store version information in your executables;

•	While tag's name can be arbitrary string, we recommend to use 4-number format like "v1.0.0.0 something", otherwise EurekaLog would not be able to understand what version this tag is for;

•	A project version will be used during sending. The version is extracted from version information of your project's executable;

•	Exception's module version is not used for sending (unless exception's module matches project's module);

•	We recommend to enable this option for production.

13. "Search match up to N numbers" (.SendGitHubMinVersion) option specifies how version search is performed.

Because bug tracker may create versions in an arbitrary format (like "Version 1" or "7.3 hotfix 2"), and application uses 4 numbers format (like "7.3.2.0") - EurekaLog has to perform heuristic search:

•	First, EurekaLog looks up exact match (e.g. "7.3.2.0" = "7.3.2.0"; or "7.3.2.0" = "v7.3.2.0");

•	Second, EurekaLog tries to find version with same numbers (e.g. "7.3.2.0" = "7.3.02.000");

•	Third, EurekaLog performs partial search (e.g. "7.3.2.0" = "7.3.2", or "7.3.2.0" = "7.3", or "7.3.2.0" = "7.3 Beta"). The search is always performed from longer matches to shorter. E.g. when searching "7.3.2.0": "7.3.2" has higher priority than "7.3".

This option indicate when EurekaLog need to stop when searching version:

•	A value of 4 means "all four numbers must match". This is a strict search.

•	Value of 3 means that search would fail if there is no match with at least 3 number (e.g. "7.3.2");

•	Value of 2 means that search would fail if there is no match with at least 2 number (e.g. "7.3");

•	Value of 1 means that search would fail if there is no match with at least 1 number (e.g. "7").

We recommend to use value of 4 for this option, because it greatly reduces possible ambiguity. However, it will mean that you have to enter each build (even very minor one) of your application in your bug tracker's configuration.

Value of 1 means using very wide criteria. We do not recommend to use it. If you are still going to use it - be sure not to enter too much sub-versions in your bug tracker, especially with added text.

Values of 2 and 3 are a good compromise.

14. "Upload bug report files for duplicates until bug is closed" (.SendGitHubUploadFilesForDups) option allows you to collect all bug reports. If this option is unchecked (default): only first bug report is uploaded and stored. All other bug reports for the same problem (identified by BugID) will be discarded. Only "Weight" field will be increased (if it is available). If this option is checked: bug reports for the same problem will be uploaded to issue.

Notes:

•	if you check this option be sure to name bug report files in unique way to avoid file names duplicates. Also, be sure to have a lot of hard disk space to store all bug reports.

•	bug reports will not be uploaded, once the issue is closed or resolved.

•	you can also stop collecting files by changing status to "In progress".

Root > Integral parts > Options > Report sending page > GitHub GitHub