使用Jenkins部署React項目的方法步驟
背景
公司的前端項目部署方式比較簡單,整個過程基本上是手動的;
目標(biāo)
通過工具實現(xiàn)以下幾個任務(wù):
- 編譯、部署自動化;
- 選擇指定版本進行回滾;
- 區(qū)分不同的分支(環(huán)境);
技術(shù)方案
- 選用 jenkins 作為部署工具;也便于后續(xù) CI 的接入;
- 使用 docker 進行編譯,確保每次編譯的環(huán)境的穩(wěn)定;
步驟
步驟一:搭建 Jenkins
搭建 Jenkins 有很多方案,這里選擇使用 docker 搭建。
docker-compose.yml 的內(nèi)容如下:
version: '3' services: fejenkins: user: root image: jenkinsci/blueocean ports: - "8080:8080" - "50000:50000" volumes: - /data/jenkins_home:/var/jenkins_home - /data/nm_cache:/var/nm_cache - /var/run/docker.sock:/var/run/docker.sock
通過 docker-compose up 命令啟動;啟動后通過初始密碼進行第一個用戶的創(chuàng)建和 Jenkins 初始化的一些列操作,初始密碼會打印在 jenkins docker 啟動命令行的輸出中,注意查看。
當(dāng)然也可以不使用 docker-compose:
docker run --rm -u root -v /data/jenkins_home:/var/jenkins_home -v /data/nm_cache:/var/nm_cache -v /var/run/docker.sock:/var/run/docker.sock -p 8080:8080 -p 50000:50000 jenkinsci/blueocean
稍做解釋:
- /data/jenkins_home:/var/jenkins_home /var/jenkins_home 是 jenkinsci image 的默認數(shù)據(jù)存放路徑,這里將路徑映射到宿主機的指定文件夾;
- /data/nm_cache:/var/nm_cache nm_cache 涵義是 node_modules cache,顧名思義,這里是想對編譯所需的 node_modules 做緩存,將緩存文件夾也映射到宿主機;
- /var/run/docker.sock:/var/run/docker.sock 這里是將宿主機運行 docker 后產(chǎn)生的 sock 文件映射到了 jenkins container 中。這樣,jenkins 中使用 docker 進行編譯時,其實是使用宿主機的 docker 來運行的,而不是在 docker container 中又啟動了 docker。這里稍微有點繞,若是暫時看不明白,需要找一些深入介紹 docker 的文章閱讀;
步驟二:配置 Jenkins
添加 Credentials
通過 Jenkins 進行 git 操作需要對應(yīng) git repo 的權(quán)限,這里需要用到有 git repo 權(quán)限的密鑰文件。同樣,通過 Jenkins 將編譯產(chǎn)物 scp 到服務(wù)器上的時候,也需要服務(wù)器的密鑰文件。
這兩類密鑰文件需要配置在 Jenkins 中,在:Jenkins > Credentials > System > Global credentials (unrestricted) 里進行 Add Credentials 的操作。
添加 Jenkins Item
Jenkins > New Item,然后選擇 Pipeline,在下面的 Pipeline 配置區(qū)域的 Definition 中選擇 Pipeline script,Script 如下:
pipeline { environment { SERVER_IP_1 = "11.22.33.44" SERVER_CREDENTIALSID = "abcd1234-abcd-abcd-abcd-abcd1234abcd" SERVER_DEPLOY_DIR = "/your/www/path/" CACHE_DIR = "/var/nm_cache/your_project_name/" GIT_URL = "git@github.com:example/example.git" GIT_BRANCH = "master" GIT_CREDENTIALSID = "abcd1234-abcd-abcd-abcd-abcd1234abcd" } agent none stages { stage('Checkout code') { agent any steps { git ( branch: "${GIT_BRANCH}", credentialsId: "${GIT_CREDENTIALSID}", url: "${GIT_URL}", changelog: true ) sh ''' ls -al cache_dir="${CACHE_DIR}" cache_nm="${CACHE_DIR}node_modules" cache_lock="${CACHE_DIR}yarn.lock" if [ ! -d "$cache_dir" ]; then mkdir ${cache_dir}; fi if [ ! -d "$cache_nm" ]; then mkdir ${cache_nm}; fi if [ -d "$cache_nm" ]; then ln -sf ${cache_nm} ./; fi if [ -f "$cache_lock" ]; then mv -n ${cache_lock} .; fi ls -al ''' } } stage('Build') { agent { docker { image 'node:8-alpine' args '' } } steps { sh ''' npm config set registry https://registry.npm.taobao.org yarn install yarn build tar -cvf build.tar build ls -al mv ./yarn.lock ${CACHE_DIR} rm -rf ./node_modules ls -al ''' archiveArtifacts artifacts: 'build.tar', fingerprint: true } } stage('Deploy') { agent any steps { unarchive mapping: ['build.tar': 'build.tar'] echo '--- Deploy ---' sshagent(["${SERVER_CREDENTIALSID}"]) { sh "scp -o StrictHostKeyChecking=no build.tar root@${SERVER_IP_1}:${SERVER_DEPLOY_DIR}" sh "ssh -o StrictHostKeyChecking=no root@${SERVER_IP_1} \"rm -rf ${SERVER_DEPLOY_DIR}build; tar -xvf ${SERVER_DEPLOY_DIR}build.tar -C ${SERVER_DEPLOY_DIR}\"" } } } } }
稍做解釋:
這個部署腳本分為三個步驟:
- Checkout code(在指定 git 倉庫通過指定證書文件獲取代碼)
- Build(通過指定命令進行編譯,將編譯后的產(chǎn)物存檔)
- Deploy(通過指定命令部署)
在 Build 階段前后,我們各做了一些工作,以求每次部署可以復(fù)用 node_modules,因為下載 node_modules 的時間可能很長,而并不是每次都會修改 package.json,所以其實 node_modules 大概率可以復(fù)用;
編譯前:
- 看指定 node_modules 緩存文件夾是否存在,不存在則新建該文件夾;
- 看緩存文件夾中是否有 node_modules 文件夾,如果沒有則新建該文件夾;并且將該文件夾軟連接到當(dāng)前目錄;
- 看緩存文件夾中是否有 yarn.lock 文件,如果有則移動到當(dāng)前文件夾;
編譯后:
- 移除 node_modules 文件夾的軟連接;
- 將 yarn.lock 文件移動到緩存文件夾中;
這里使用了 yarn install 的某些特性:
- 沒有 node_modules 或者 yarn.lock 時會安裝全量依賴;
- 有 node_modules 和 yarn.lock 但是 yarn.lock 和 package.json 不匹配時,會安裝所需依賴;
- 有 node_modules 和 yarn.lock,且 yarn.lock 和 packge.json 配置時,跳過安裝依賴;
使用
編譯和部署
編譯和部署直接點擊 Build Now 即可;
回滾
回滾的本質(zhì)其實是:重新部署某個歷史版本。在 Build History 找到想要重新部署的版本,點擊 Restart from Stage,在新頁面中選擇 Stage Name 為 Deploy。
其他
若是想要進入 docker container 交互,可以通過以下命令
docker exec -i -t [dockername] /bin/bash
以上就是本文的全部內(nèi)容,希望對大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
關(guān)于useEffect的第二個參數(shù)解讀
這篇文章主要介紹了關(guān)于useEffect的第二個參數(shù),具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2022-09-09用react實現(xiàn)一個簡單的scrollView組件
這篇文章主要給大家介紹一下如何用 react 實現(xiàn)一個簡單的 scrollView組件,文中有詳細的代碼示例,具有一定的參考價值,需要的朋友可以參考下2023-07-07React項目中fetch實現(xiàn)跨域接收傳遞session的解決方案
這篇文章主要介紹了React項目中fetch實現(xiàn)跨域接收傳遞session的解決方案,本次項目使用了react框架,同時使用fetch取代ajax作為獲取接口數(shù)據(jù)的交互方法,下面就對這次問題的解決做個總結(jié),需要的朋友可以參考下2022-04-04