Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/teamtigers/minisauras
An open-source CI/CD automation tool based on :octocat: GitHub Actions that pulls all the JavaScript and CSS files from your base branch, minify them and creates a pull-request with a new branch.
https://github.com/teamtigers/minisauras
action actions-hackathon actionshackathon ci-cd dev-community dev-hackathon github github-actions github-core javascript javascript-library minisauras nodejs octokit terser webpack
Last synced: about 11 hours ago
JSON representation
An open-source CI/CD automation tool based on :octocat: GitHub Actions that pulls all the JavaScript and CSS files from your base branch, minify them and creates a pull-request with a new branch.
- Host: GitHub
- URL: https://github.com/teamtigers/minisauras
- Owner: TeamTigers
- License: mit
- Created: 2020-09-06T13:29:12.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-10-17T13:25:59.000Z (about 1 year ago)
- Last Synced: 2024-05-12T17:30:59.042Z (6 months ago)
- Topics: action, actions-hackathon, actionshackathon, ci-cd, dev-community, dev-hackathon, github, github-actions, github-core, javascript, javascript-library, minisauras, nodejs, octokit, terser, webpack
- Language: JavaScript
- Homepage: https://github.com/marketplace/actions/minisauras
- Size: 3.61 MB
- Stars: 48
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://dev.to/_shunjid/minisauras-a-github-action-to-minify-css-and-js-files-34b9)
[](https://hits.seeyoufarm.com)
# Minisauras :tada:
Minisauras is an open-source CI/CD automation tool based on :octocat: [**GitHub Actions**](https://github.com/features/actions) that pulls all the JavaScript and CSS files from your base branch, minify them and creates a pull-request with a new branch.
## How it works
- Traverse through a given directory (if not provided, traverse from root), finds all the JavaScript & CSS files within it and it's sub-directories.
- Afterwards, **Minisauras** minify all those files.
- Finally, it creates a new branch in your repository, push those changes and creates a pull request that can be merged in your base branch.
## Usage
- Create a [personal access token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token).
- Then [setup a secret](https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) using that personal access token in your desired repository.
- Create a workflow. For example: **main.yml** under (.github/workflows) directory.
- In the workflow, provide following things:
* Personal access token. For example: ${{ secrets.TOKEN }} if you set your secret with a name 'TOKEN'.
* The desired directory in which you want to minify CSS and JS files. For example: './' for root and 'src/' for src directory.
## Examples
_**If you want to minify all your JS and CSS files under root directory**_
```yml
name: minisauras
on: [push]
jobs:
read:
runs-on: ubuntu-18.04
steps:
- name: Checkout
uses: actions/checkout@v2
- name: minisauras
uses: TeamTigers/[email protected]
env:
GITHUB_TOKEN: ${{ secrets.TOKEN }}
id: dir
with:
directory: './' ## minify all files from root directory
```
_**If you want to minify all your JS and CSS files under your custom directory ex. assets/js & assets/css**_
```yml
name: minisauras
on: [push]
jobs:
read:
runs-on: ubuntu-18.04
steps:
- name: Checkout
uses: actions/checkout@v2
- name: minisauras
uses: TeamTigers/[email protected]
env:
GITHUB_TOKEN: ${{ secrets.TOKEN }}
id: dir
with:
directory: 'assets/' ## minify all files under assets directory
```
## Example of usage
There you go !! We have created an example repository where you can see how minisauras has minified all the CSS and JavaScript files as well as created a new branch and sent a [pull request](https://github.com/TeamTigers/minisauras-example/pull/1).
📌 Visit the example repository at : https://github.com/TeamTigers/minisauras-example
[](https://github.com/TeamTigers/minisauras-example/)
## License
This project is licensed under [MIT](LICENSE)
## If you like our work please give it a :star: