Synchronization

Here are the details how the synchronization is performed between the code provided by Probe Software and the GitHub repository of the openMicroanalysis project. The synchronization was found to be the best compromise to allow Probe Software to continue distributing its code as it prefers and to make the code available online on GitHub as the other openMicroanalysis projects.

Input

The Probe Software code for CalcZAF is distributed in a ZIP file, containing the source code and required files for this program. It also contains a VERSION.TXT file which contains the latest changes to the project.

Script

A Python script (sync.py) was written to:

1. Pull repository from GitHub
2. Download ZIP containing CalcZAF source code from Probe Software website
3. Parse VERSION.TXT text file and compare for new changes
4. Extract files from ZIP
5. Add modified files, commit and push to GitHub

The script is written in pure Python and has no dependency. Parsing the VERSION.TXT is done using regular expression as the structure is well-defined. Changes since the last synchronization are combined into a new commit message. Tags are added for new versions. All modifications are then push to GitHub.

Continuous integration

The script is run using GitHub Actions, every Monday, Wednesday and Friday at 6am (UTC).