CHAOSS metrics have been defined to provide an in-depth view into the various features of an open-source project. The metrics are also a key input to help organizations strategically invest their resources.
M.A.R.S. (Metrics Automated Release System) aim is to automate & improve the metric release process. Keeping in mind the ever evolving CHAOSS, the system is scalable and flexible enough for easy tweaking in future.
The final outcome is generation of reports for the metrics and their translations counterparts respectively.< 7991 /p>
M.A.R.S. supports Linux (Debian based) and MacOS based systems only.
Currently, it can be used to generate the report of English version of metrics that exist in the working group repositories.
There are two ways to run M.A.R.S:
- Using Docker
- Using Python virtual environment
Refer to this README to know more details about its usage.
Note: - M.A.R.S for translations is still under development
The following image gives a high level overview of the workflow of M.A.R.S.
A rough walkthrough of the automation process:
- Load the yml conf file
- Load the side scripts
- Cleanup test_env directory
- Clone the WG repositories
- Generate relative paths to metric markdown files in various WGs
- Pull all the metrics in base folder
- Make a common images directory
- Decrease heading levels (only in metric markdowns) by prepending
## - Convert metrics markdown to tex
- Generate focus areas tables in tex (2 level hierarchy)
- Generate WG markdowns tex files for headings (3 level hierarchy)
- Add front and end matter
- Call pandoc to generate the final PDF
- Move the final PDF to the output directory
The M.A.R.S project welcomes all kinds of contributions and suggestions. See CONTRIBUTING.md for more information.
Licensed under MIT License