GitHub Action to provide file size reports
Provides comparison report on files size by input parameters.
sourceData
Optional JSON data source file with action parameters:
[
{
"reportName": "african proverbs report",
"sourceFilePath": "./data/african_proverbs.json",
"targetFilePath": "./data/african_proverbs_unique.json"
},
{
"reportName": "gypsy proverbs report",
"sourceFilePath": "./data/gypsy_proverbs.json",
"targetFilePath": "./data/gypsy_proverbs_unique.json"
}
]
[
{
"reportName": "african proverbs report",
"sourceFilePath": "./data/african_proverbs.json",
"targetFilePath": "./data/african_proverbs_unique.json",
"sizeUnit": "kb"
},
{
"reportName": "gypsy proverbs report",
"sourceFilePath": "./data/gypsy_proverbs.json",
"targetFilePath": "./data/gypsy_proverbs_unique.json",
"sizeUnit": "b"
}
]
reportName
Optional Report name
sourceFilePath
Optional Source file path
targetFilePath
Optional Target file path
sizeUnit
Optional File size units (any of b|kb|mb|gb|tb|pb)
fileReport
JSON representation of files size report
- name: File size
uses: alexrogalskiy/github-action-file-size@master
with:
reportName: 'Proverbs File Diff'
sourceFilePath: './data/african_proverbs.json'
targetFilePath: './data/african_proverbs_unique.json'
sizeUnit: 'kb'
Running locally:
npm run start:action --action github-action-file-size --reportName 'Proverbs File Diff' --sourceFilePath './data/african_proverbs.json' --targetFilePath './data/african_proverbs_unique.json' --sizeUnit 'kb'
File Size is distributed under LGPL version 3 or later, [License]. LGPLv3 is additional permissions on top of GPLv3.
File Size is maintained by the following GitHub team-members:
with community support please contact with us if you have some question or proposition.
The project uses SemVer for versioning. For the versions available, see the tags on this repository.
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us (emoji key).
This project follows the all-contributors specification. Contributions of any kind are welcome!
See also the list of contributors who participated in this project.
Like File Size ? Consider buying me a coffee :)