To download the latest stable version go here.
Program generates one text file containing diff from given repositories. By default it generates diff from last 7 days. Can be run on Windows and Linux.
It handles Git, Mercurial and SVN version control systems. To produce diffs, program executes following commands:
For Git: git log --all --remotes=origin --patch --author=userName --since yyyy-MM-dd --until yyyy-MM-dd
For Mercurial: hg log --patch --user userName --date "yyyy-MM-dd to yyyy-MM-dd"
For SVN: svn log --diff --search userName --revision {yyyy-MM-dd}:{yyyy-MM-dd}
If code is protected by the owner and no code is not allowed inside diff then following commands are executed:
For Git: git log --remotes=origin --oneline --author=userName --since yyyy-MM-dd --until yyyy-MM-dd
For Mercurial: hg log --style changelog --user userName --date "yyyy-MM-dd to yyyy-MM-dd"
For SVN: svn log --verbose --search userName --revision {yyyy-MM-dd}:{yyyy-MM-dd}
Generated file is uploaded to SharePoint as copyright item for given user. In case of any error, the popup window with relevant message will be shown.
Application logs everything. Logs can be found inside following folder ${APP_HOME}/logs.
There are few ways to execute this program:
- from command line java -jar with params,
- from command line java -jar + application.properties at the same location as *.jar file,
- double click on *.jar file will run the application in UI mode and this is the default mode, description of user interface can be found here
For Windows
java -jar Gipter.jar useUI=N author="Anakin Skywalker" itemPath="c:\\Path\\to\\git\\diff\\item"
projectPath="c:\\Path\\to\\git\\project1,c:\\Path\\to\\git\\project"
For Linux
java -jar Gipter.jar useUI=N author="Anakin Skywalker" itemPath="/home/wall-e/Path/to/git/diff/item"
projectPath="/home/eva/Path/to/git/project1,/home/eva/Path/to/git/project2"
%JFX11% = path to javafx distribution version 11+.
java -jar --module-path %JFX11% --add-modules="javafx.fxml,javafx.controls,javafx.media,javafx.web,javafx.swing" --add-exports="javafx.base/com.sun.javafx.event=ALL-UNNAMED" Gipter.jar
If there are application.properties file at the same location as your jar file then program can be run as follows: java -jar Gipter.jar useUI=N
If program is executed with commandline parameters and application.properties file at the same time, then setup from commandline has higher priority. Unless preferredArgSource is set to FILE, then application.properties has higher priority.
Generated file name by default is year-monthName-week-weekNumber.txt. If diff is generated with end date set in the past then diff file name is year-monthName-startDate-endDate.txt.
If parameter itemFileNamePrefix is set then its value is added at the front of the file name. File name (without extension) is used also as the title of the toolkit item, that is created.
You can pass some parameters commandline way and other application.properties way. For instance if you do not want to set your password in application.properties, you can pass it as commandline param.
When application is executed with `uploadType = TOOLKIT_DOCS', then item file is a zip file. It is because there could be more then one document created or changed by the user.
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.
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.
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.
Below parameters are mandatory for toolkit:
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 item type TOOLKIT_DOCS
Note: When periodInDays is used together with startDate then startDate has higher priority.
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.
This option should be used by the users that do not create code, but work with project documentation. If this is the case then 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.
Toolkit docs Case
The user is Yoda. Documents are located in 2 folders: Deliverables and DocumentLibrary. We want to generate item for date range now - 30 days and now. The history of documents is as follows:
Deliverable-doc:
| Modified by | Date | Version |
|---|---|---|
| Yoda | now - 40 days | 1.0 |
| Kit Fisto | now - 35 days | 2.0 |
| Yoda | now - 25 days | 3.0 |
| Yoda | now - 15 days | 4.0 |
| Obi-Wan Kenobi | now - 13 days | 5.0 |
| Obi-Wan Kenobi | now - 12 days | 6.0 |
| Yoda | now - 2 days | 7.0 |
| Ashoka Tano | now - 1 days | 9.0 |
DocumentLibrary-doc:
| Modified by | Date | Version |
|---|---|---|
| Mace Windu | now - 15 days | 1.0 |
| Kit Fisto | now - 14 days | 2.0 |
| Ashoka Tano | now - 6 days | 3.0 |
| Anakin Skywalker | now - 5 days | 4.0 |
| Shak Ti | now - 4 days | 5.0 |
| Obi-Wan Kenobi | now - 3 days | 6.0 |
| Yoda | now - 2 days | 7.0 |
The item will contains following documents:
Deliverable-doc-2.0, Deliverable-doc-4.0, Deliverable-doc-6.0, Deliverable-doc-7.0 - all document before change and Yoda's last change.
DocumentLibrary-doc-6.0, DocumentLibrary-doc-7.0 - document before Yoda's change and the last change made by Yoda.
All these files will be zipped into one file and uploaded as one item.
Case 1
It may be that owner of the code forbids to share the code in anyway but you are allowed to put headers of the changes in the diff.
In that case user should set parameter uploadType to PROTECTED.
For GIT the PROTECTED protection will contain entries as follows:
a42212890 Cleaning code.
5cfc248ad Fixing that balck hole.
No code! Just:
- who - optional,
- when - optional,
- commit hash - mandatory,
- branch name - optional,
- commit message - mandatory.
Case 2
It also may be that owner of the code forbids to share any kind of information about the code and changes, even headers.
If so then user should upload to SharePoint file with the statement. Application can do it for user if only uploadType parameter is set as STATEMENT.
To setup toolkit details only two parameters has to be set: toolkitUsername and toolkitPassword. If parameters are not set the application will generate diff file and report an error.
Popup window will be displayed and in the logs there will be relevant entry. If parameters are set then new item in the toolkit will be created. New item will contain attachment, which is generated
file with diffs from repositories. Below are details of that item:
Title: diff file name
Submission date: endDate + LocalTime.now()
Classification: Changeset (repository change report)
Body: vcsName diff file or STATEMENT diff
Example 1
If you want to create diff for Smeagol Golum and Project1 from last 7 days then create following setup in your application.properties:
author=Smeagol Gollum
itemPath=c:\\Path\\to\\git\\diff\\item
projectPath=c:\\Git\\Project1
Remember: Java + Windows == double backslash in the paths! There is no need for double backslashes in Linux. In linux it could be like this projectPath=/home/Gollum/Git/Project1
Example 2
If you want to create diff for Project1 and Project2 from last 12 days and for author Anakin Skywalker, create following setup in your application.properties:
author=Anakin Skywalker
itemPath=c:\\Path\\to\\git\\diff\\item
projectPath=c:\\Git\\Project1,c:\\Git\\Project2
periodInDays=12
Example 3
If you want to create diff for Project1, Project2 and Project3 from 1st of June 2018 to 30th of June 2018 for authors Ezra Bridger and Kanan Jarrus, create following setup in your application.properties:
author=Ezra Bridger,Kanan Jarrus
itemPath=c:\\Path\\to\\diff\\item
projectPath=c:\\Git\\Project1,c:\\Svn\\Project2,c:\\hg\\Project3
startDate=2018-06-01
endDate=2018-06-30
itemFileNamePrefix=june
Explanation: set itemFileNamePrefix=june in order to have file name starts with june.
Example 4
If you want to create diff for Git-Project with author Shak Ti, Svn-Project with author Starkiller and Hg-Project with author Juno from 1st of June 2018 to 30th of June 2018 for authors Ezra Bridger and Kanan Jarrus, create following setup in your application.properties:
gitAuthor=Shak Ti
svnAuthor=Starkiller
mercurialAuthor=Juno
itemPath=c:\\Path\\to\\diff\\item
projectPath=c:\\Git-Project,c:\\Svn-Project,c:\\Hg-Project
startDate=2018-06-01
endDate=2018-06-30
itemFileNamePrefix=june
Example 5
If you want to create SVN diff for author Kit Fisto and Project1 which is protected by the owner, but you are allowed to use headers of the changes,
create following setup in your application.properties:
svnAuthor=Kit Fisto
itemPath=/home/Vader/Path/to/diff/item
projectPath=/home/Vader/SVN/Project1
uploadType=SIMPLE
Explanation: Java + Linux == simple paths with slashes!
Example 6
If you want to create SVN diff for Project1 that is fully protected by the owner, then create following setup in your application.properties:
itemPath=/home/Vader/Path/to/statement/my-statement.docx
uploadType=STATEMENT
To all above examples toolkit parameters (toolkitUsername & toolkitPassword) has to be set up.
To download the latest stable version go here.
In order to execute the application from the IDE for Java 11+ use the following as VM options:
-p {PATH-TO-JAVAFX-SDK}\lib --add-modules=javafx.fxml,javafx.controls,javafx.media,javafx.web,javafx.swing --add-exports=javafx.base/com.sun.javafx.event=ALL-UNNAMED
MIT - please read the file LICENSE.