Parameters - PreCyz/GitDiffGenerator GitHub Wiki

Here there are described all parameters that the application uses. Parameters can be devided into 3 groups. These groups are described below.

configurationName - Each defined configuration has its own unique name. This parameter is the unique name of the configuration.
author - comma separated users who committed the code.
committerEmail - email of the user who committed the code. For git user email from git config stored under key 'user.email'.
uploadType - possible values are SIMPLE, PROTECTED and STATEMENT. Default value is SIMPLE. Further explanation here.
itemPath - path where file with git diff should be saved or if uploadType is set as STATEMENT then full path to the file with statement.
projectPath - comma separated project paths containing .git, .svn or .hg folders.
periodInDays - integer number. Default value is 7. It helps define start date of diff calculations. Start date is now - periodInDays, end date is now. When periodInDays is used together with startDate then startDate has higher priority.
startDate - start date of diff given in format yyyy-MM-dd.
endDate - end date of diff given in format yyyy-MM-dd. By default it is set as now.
itemFileNamePrefix - if given then this value will be used as prefix of the diff file name.
gitAuthor - author specific for git repository stored at git config under key 'user.name'. When used together with author, this parameter has higher priority.
mercurialAuthor - author specific for mercurial repository. When used together with author, this parameter has higher priority.
svnAuthor - author specific for svn repository. When used together with author, this parameter has higher priority.
confirmationWindow - if parameter set as Y then confirmation window will be displayed after successful upload. Default value is N.
preferredArgSource - if parameter set as FILE then arguments from application.properties will be resolved as first. Default value is CLI. This parameter can be changed only from command line.
skipRemote - if parameter set as N then git diff will be generated only from origin (--remotes=origin). If set as Y then git diff will be generated only from local git repository. Default value is Y.
fetchAll - if parameter set as N then there will your repositories will not be fetched / updated before the diff generation. Default value is Y.
fetchTimeout - Default value is 60 seconds. When fetch --all command is executed then the application will wait 60 seconds for command to complete. If it's not completed then the command will be terminated, and the whole process will continue. The value can be changed when fetchAll is active.

useUI - if parameter set as N application will be launched in command line mode. If set as Y then UI mode is launched. Default value is Y.
activeTray - used in UI, tells if tray icon should be active or not. Default value is Y.
silentMode - used in UI, tells if application should be executed and located directly in tray icon. It is used by startup functionality. Default value is N.
enableOnStartup - used in UI, enables application on system start up, if value on is Y then application will be launched on system start.
loggerLevel - If given then all loggers in the application has that logger level.
itemUpload - Default value is Y. It determins if item is going to be uploaded to the master data system (Toolkit).
smartZip - Default value is Y. When it is on and the size of the item is larger than 500KB, then the item is going to be zipped just before the upload.

toolkitUsername - user name used as a login to SharePoint. Also this value is taken when user's root folder in toolkit is calculated.
toolkitPassword - user password used to log in into SharePoint.

toolkitProjectListNames - comma separated names of the folders to scan on toolkit, when looking for changes in documents made by user. Default value is Deliverables.
deleteDownloadedFiles - if Y then all downloaded files from toolkit will be downloaded afterwards. This parameter works together with upload type TOOLKIT_DOCS

• SIMPLE - full git diff is generated and uploaded,
• PROTECTED - no code can not be shared in anyway but diff can contain headers of changes,
• STATEMENT - not even headers of changes are allowed in diff. File with statement is uploaded to SharePoint instead.
• TOOLKIT_DOCS - scanning given project documentation to find documents that were changed by the user.

• CLI - commandLine arguments will be used as first then missing parameters will be read from application.properties,
• FILE - arguments from application.properties will be used as first then missing parameters will be read from commandLine arguments.
• UI - it is used by the UI. Arguments from ui-application.properties will be used as first then missing parameters will be read from commandLine arguments.

Each toolkit project has its own list, that store the documentation of the project. The most known list is Deliverables.
But there are more lists, depends on the project. If produced by you documents are kept under different lists
then you should enter comma separated display names of the lists (the names what you see on the web page of your project).
If display names don't work then use the names taken from the links of these lists.

It is an upload type. This option should be used by the users that do not create code, but work with the documentation. In that case the copyright items are created from documentations produced by the user.
How the application handles such a case? Documentation of the project is kept on SharePoint in different folders. In order to extract the changes from these documents made by the user,
application will scan the documents from given folders within given date range (startDate and endDate). Because of the nature of SharePoint, the produced item will consist pair of documents before and after the change made by the user.
The example will explain what exactly item consists of.

The document consists of the following history:

1. Change made by Obi-Wan Kenobi on 2021-01-01
2. Change made by Yoda on 2021-02-01
3. Change made by Mace Windu on 2021-03-01
4. Change made by Yoda on 2021-04-01
5. Change made by Obi-Wan Kenobi on 2021-05-01
6. Change made by Kit Fisto on 2021-06-01
7. Change made by Ki-Adi-Mundi on 2021-07-01
8. Change made by Obi-Wan Kenobi on 2021-08-01
9. Change made by Obi-Wan Kenobi on 2021-09-01

The copyright item generated for Obi-Wan Kenobi from 2021-01-01 will contain the following list of the documents (zipped into one file):
Pair no 1: 1 & 2
Pair no 2: 4 & 5
Pair no 3: 7 & 9
Pair contains snapshot before and after the last change made by the requested author.