Skip to content
package

GitHub Action

File Size

v2.0.1 Latest version

File Size

package

File Size

Provides report comparing information on file size

Installation

Copy and paste the following snippet into your .yml file.

              

- name: File Size

uses: AlexRogalskiy/github-action-file-size@v2.0.1

Learn more about this action in AlexRogalskiy/github-action-file-size

Choose a version

File Size

GitHub Action to provide file size reports

GitHub marketplace

management: perfekt👌 code style: prettier Mergify Status Reviewed by Hound Chat

DeepSource DeepScan grade

GitHub tag (latest by date) GitHub Release Date Lines of code GitHub closed issues GitHub closed pull requests GitHub repo size GitHub last commit GitHub language count GitHub search hit counter GitHub Repository branches GitHub Repository dependents Renovatebot Dependabot NewReleases Hits-of-Code dependencies Status devDependencies Status

Codeac Coverage Status codebeat badge Total alerts Language grade: JavaScript codecov CI CircleCI GitHub Super-Linter Commitizen friendly ComVer Public workflows that use this action. Licence

Chat Open questions Open bugs

Table of contents

Description

Typescript Project Status: Active – The project has reached a stable, usable state and is being actively developed. Project created status Project updated status

Provides comparison report on files size by input parameters.

Inputs

sourceData

Optional JSON data source file with action parameters:

Complete 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"
    }
]

Basic parameters

[
    {
        "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)

Outputs

fileReport

JSON representation of files size report

Examples

- 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'

Visitor stats

GitHub page hits

GitHub stars GitHub forks GitHub watchers

Licensing

File Size is distributed under LGPL version 3 or later, [License]. LGPLv3 is additional permissions on top of GPLv3.

license

Authors

File Size is maintained by the following GitHub team-members:

  • Author

with community support please contact with us if you have some question or proposition.

Versioning

The project uses SemVer for versioning. For the versions available, see the tags on this repository.

Contribution

Contributors Display

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!

PRs Welcome Github contributors

See also the list of contributors who participated in this project.

Acknowledgement

Stargazers repo roster for @AlexRogalskiy/github-action-file-size

Forks

Forkers repo roster for @AlexRogalskiy/github-action-file-size

Development Support

Like File Size ? Consider buying me a coffee :)

Become a Patron Buy Me A Coffee KoFi


forthebadge forthebadge forthebadge