devatherock/minify-js

Minify-JS GitHub Action/CI插件

镜像概述和主要用途

Minify-JS是一个GitHub Action/CI插件，用于压缩HTML、JavaScript和CSS文件。它基于npm minify包，可集成到各类CI/CD流程中，通过压缩静态资源减小文件体积，提升应用加载性能。

核心功能和特性

• 支持HTML、JavaScript和CSS文件的压缩处理
• 可配置输入目录和输出路径，灵活控制文件处理范围
• 可选为压缩文件添加.min后缀，便于区分原始文件与压缩文件
• 通过正则表达式设置文件包含和排除规则，精确控制处理对象
• 兼容多种CI/CD平台：GitHub Actions、Docker、Vela、CircleCI

使用场景和适用范围

适用于前端项目在CI/CD流程中自动化压缩静态资源的场景，可在构建过程中优化HTML、JS、CSS文件，减少网络传输量，提升网页加载速度，尤其适合需要优化性能的生产环境部署。

详细使用方法和配置说明

GitHub Action

可通过以下参数配置Action：

• directory：待压缩的文件或文件夹路径，默认当前目录及其子目录下所有文件
• output：压缩文件保存路径，默认保存在原文件路径
• add_suffix：是否添加.min后缀，默认true
• inclusions：多行字符串，每行是一个正则表达式，表示要包含的文件/路径，默认包含所有文件
• exclusions：多行字符串，每行是一个正则表达式，表示要排除的文件，默认不排除任何文件

yaml
jobs:
  build:
    runs-on: ubuntu-latest      # 基于Docker的GitHub Action需运行在Linux环境
    steps:
      - name: 检出代码
        uses: actions/checkout@v4
      - name: HTML/CSS/JS压缩
        uses: docker://devatherock/minify-js:3.1.0
        with:
          directory: 'src'      # 可选
          output: 'minify/src'  # 可选
          add_suffix: false     # 可选
          inclusions: |-        # 可选
            .*assets.*
            .*static/index.html
          exclusions: |-        # 可选
            .*assets/generated/.*

Docker

shell
docker run --rm \
  -v "/path/to/files":/work \
  -w=/work \
  -e PARAMETER_INPUT_PATH=/work/src \
  -e PARAMETER_OUTPUT_PATH=/work/minify/src \
  -e PARAMETER_ADD_SUFFIX=false \
  -e PARAMETER_INCLUSIONS=".*assets.*\n.*static/index.html" \
  -e PARAMETER_EXCLUSIONS=".*assets/generated/.*" \
  devatherock/minify-js:3.1.0

Vela

可通过以下参数配置插件：

• input_path：待压缩的文件或文件夹路径，默认当前目录及其子目录下所有文件
• output_path：压缩文件保存路径，默认保存在原文件路径
• add_suffix：是否添加.min后缀，默认true
• inclusions：多行字符串，每行是一个正则表达式，表示要包含的文件/路径，默认包含所有文件
• exclusions：多行字符串，每行是一个正则表达式，表示要排除的文件，默认不排除任何文件

yaml
steps:
  - name: minify_js
    ruleset:
      branch: master
      event: push
    image: devatherock/minify-js:3.1.0
    parameters:
      input_path: src
      output_path: minify/src
      add_suffix: false
      inclusions: |-
        .*assets.*
        .*static/index.html
      exclusions: |-
        .*assets/generated/.*        

CircleCI

yaml
version: 2.1
jobs:
  minify_js:
    docker:
      - image: devatherock/minify-js:3.1.0
    working_directory: ~/my-repo
    environment:
      PARAMETER_INPUT_PATH: src
      PARAMETER_OUTPUT_PATH: minify/src
      PARAMETER_ADD_SUFFIX: false
      PARAMETER_INCLUSIONS: '.*assets.*\n.*static/index.html'
      PARAMETER_EXCLUSIONS: '.*assets/generated/.*'
    steps:
      - checkout
      - run: node /app/bin/cli.mjs

测试

要测试最新的插件镜像，请运行以下命令：

shell
./gradlew test