auto-minify
auto-minify copied to clipboard
nizarmah
Minifies JS and CSS files in GitHub workflows.
auto-minify
Minifies JS and CSS files.
Quickstart
on: [push]
jobs:
minify:
runs-on: ubuntu-latest
steps:
- name: check out the repository
uses: actions/checkout@v4
- name: auto minify the files
uses: nizarmah/auto-minify@v3
- name: auto commit the minified files
uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: "bot: Add auto minified files"
Features
- Flexibility: Minify JS and CSS files with the engine of your choice.
- Customization: Specify directories, handle file overwrites, and control traversal depth.
- Reliability: Continuous integration tests validate functionality and predictability.
Customization
Inputs
| Input | Description | Required | Default Value |
|---|---|---|---|
| directory | Directory that contains the files you want to minify. | false | . |
| output | Directory that contains the minified files. | false | . |
| overwrite | Overwrites the existing files with the minified version. Defaults to false. | false | false |
| maxdepth | Descend at most levels (a non-negative integer) levels of directories below the starting-points. | false | |
| js_engine | Specifies which of the supported packages minifies JS files. Supported packages: babel, uglify-js |
false | babel |
| css_engine | Specifies which of the supported packages minifies CSS files. Supported packages: lightning, clean-css |
false | lightning |
[!IMPORTANT] All paths are relative to the root of the repository.
outputdefaults to the same directory asdirectory, unless specified.
maxdepthtraverses into all subdirectories by default.
Examples
Overwriting existing files
on: [push]
jobs:
minify:
runs-on: ubuntu-latest
steps:
- name: check out the repository
uses: actions/checkout@v4
- name: replace js and css files with minified ones
uses: nizarmah/auto-minify@v3
with:
overwrite: true
- name: auto commit the minified files
uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: "bot: Add auto minified files"
Restricting traversal depth
on: [push]
jobs:
minify:
runs-on: ubuntu-latest
steps:
- name: check out the repository
uses: actions/checkout@v4
- name: auto minify files at most 1 level deep
uses: nizarmah/auto-minify@v3
with:
maxdepth: 1
- name: auto commit the minified files
uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: "bot: Add auto minified files"
Targeting specific directories
on: [push]
jobs:
minify:
runs-on: ubuntu-latest
steps:
- name: check out the repository
uses: actions/checkout@v4
- name: auto minify files in the js directory
uses: nizarmah/auto-minify@v3
with:
directory: 'js'
- name: auto commit the minified files
uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: "bot: Add auto minified files"
Saving to a different directory
on: [push]
jobs:
minify:
runs-on: ubuntu-latest
steps:
- name: check out the repository
uses: actions/checkout@v4
- name: auto minify files to a different directory
uses: nizarmah/auto-minify@v3
with:
directory: 'assets'
output: 'mini_assets'
- name: auto commit the minified files
uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: "bot: Add auto minified files"
Using different engines
on: [push]
jobs:
minify:
runs-on: ubuntu-latest
steps:
- name: check out the repository
uses: actions/checkout@v4
- name: auto minify files with different engines
uses: nizarmah/auto-minify@v3
with:
js_engine: 'uglify-js'
css_engine: 'clean-css'
- name: auto commit the minified files
uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: "bot: Add auto minified files"
[!TIP] If you can't find what you're looking for, check our automated tests.
Contributing
Your contributions are welcome! There's no guide yet, but don't hold back.
If it's a bug, please provide a minimal example to reproduce it.
If it's a feature, please provide a use case for it.
If it's a pull request, please provide a description and a test case for it.
Cheers!
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
We also provide major version tags to make it easier to always use the latest release of a major version. For example, you can use nizarmah/auto-minify@v3 to always use the latest release of the current major version.
License
This project is licensed under the GPL-3.0 License. See the LICENSE file for details.
nizarmah