简介
"ci.sh"是一个npm包,提供了一个可重用的shell脚本,帮助前端projcet通过Gitlab CI等工具自动化构建。该脚本可以执行多种操作,如安装依赖、读取配置文件、打包和上传静态资源等。
安装和使用
在项目的根目录中执行以下命令,即可安装ci.sh包:
npm install ci.sh --save-dev
在使用ci.sh时,需要将其加入project的CI配置脚本中。以下是一个此类脚本的示例:
#!/usr/bin/env bash set -e # Stop script on error echo "Running ci.sh release script" ci.sh start # Start executing ci.sh echo "Finished. Project is built, tested, and deployed."
功能模块
ci.sh的功能模块如下:
安装依赖
ci.sh提供了一种简单的方法来安装依赖,同时支持缓存。执行以下命令即可:
ci.sh install
注意:ci.sh默认使用npm来安装依赖,如果项目中使用yarn,则需要在执行该命令之前设置“NPM_CLIENT=yarn”。
打包
为了压缩网页、CSS、JS等静态资源,ci.sh提供了打包命令。执行以下命令即可:
ci.sh build
ci.sh使用Webpack打包,并将打包结果输出到dist目录中。
部署
ci.sh可以支持自动化部署静态资源到CDN或其他服务器。以下是一个使用AWS S3作为部署服务器的示例:
AWS_ACCESS_KEY=[key] AWS_SECRET_KEY=[secret] AWS_REGION=[region] AWS_BUCKET=[bucket] ci.sh deploy
以上命令会读取项目配置文件中的AWS_ACCESS_KEY、AWS_SECRET_KEY等参数,并将打包结果上传到指定的AWS S3 bucket中。
配置文件
ci.sh可以根据项目中的配置文件自动执行一些行为。默认情况下,ci.sh会将该配置文件存储在“.cish.yml”中。
以下是一个cish.yml的示例:
-- -------------------- ---- ------- - ----- ------------- -------- - ---- ----------- --- --------- - ---- ------- ------- - --------- - ---------- - ----------- ------- --------------- ----- --------------- -------- ----------- -------- ----------- --------
该文件定义了安装依赖的命令、待打包的资源路径,以及部署需要的AWS配置信息。在调用ci.sh时,该配置文件会被自动加载并执行其中定义的操作。
总结
ci.sh是一个强大的npm包,为前端开发人员提供了自动化构建、缓存依赖、打包和部署等功能。上述介绍了该包的安装和使用方法、功能模块以及配置文件。通过学习ci.sh,我们可以更加简单、高效地构建和部署我们的前端应用程序。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60065f70238a385564ab66eb