Skip to content

file-diff

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

file-diff

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
CHANGELOG.md
CHANGELOG.md
 
 
README.md
README.md
 
 
action.yml
action.yml
 
 
index.js
index.js
 
 
package.json
package.json
 
 
utilities.js
utilities.js
 
 

README.md

File diff

A GitHub Action for comparing compiled assets between branches.

Inputs

head-path

Required Path to file or directory for file sizes analysis.

base-path

Optional Path to another directory against which to perform file comparisons.

token

Optional GitHub token for accessing the GitHub API. Defaults to ${{ github.token }}.

file-glob-pattern

Optional Glob pattern for selecting files to compare. Defaults to dist/*.

comment

Optional If true, add a comment on the pull request with the results of the comparison. Defaults to true.

comment-header

Optional Header content for the comment. Markdown is supported. Defaults to ## File metrics.

Outputs

has-changed

True if the overall file size has changed, false otherwise.

total-size

Total size of all files for this branch in bytes.

Example usage

name: Compare compiled output file size
uses: "spectrum-tools/gh-action-file-diff"
with:
  head-path: ${{ github.workspace }}/pull-request
  base-path: ${{ github.workspace }}/base-branch
  file-glob-pattern: |
    components/*/dist/*.{css,json}
    components/*/dist/themes/*.css