從零用VitePress搭建博客教程(7) -– 如何用Github Actions自動化部署到Github Pages?

来源:https://www.cnblogs.com/myboogle/archive/2023/10/24/17784015.html
-Advertisement-
Play Games

接上一節:從零用VitePress搭建博客教程(6) -– 第三方組件庫的使用和VitePress搭建組件庫文檔 我們搭建完成vitePress後,那麼接下來就是如何部署到線上伺服器,這裡使用Github Pages,免得自己購買伺服器,當然你也可以自己購買伺服器來部署(比如阿裡雲伺服器)。 在部署 ...


接上一節:從零用VitePress搭建博客教程(6) -– 第三方組件庫的使用和VitePress搭建組件庫文檔 

我們搭建完成vitePress後,那麼接下來就是如何部署到線上伺服器,這裡使用Github Pages,免得自己購買伺服器,當然你也可以自己購買伺服器來部署(比如阿裡雲伺服器)。

在部署之前,我們先簡單瞭解下Github ActionsGithub Pages

一、基本概念認識

1、理解Github Actions

中文文檔地址:https://docs.github.com/zh/actions

簡單說,Github Actions就是GitHub官方提供的自動化(CI/CD)服務, 通過它可以完成自動化測試、集成、部署等操作。

它的優勢有:

  1. 和GitHub集成更容易
  2. 支持復用其他人的基本片段

GitHub Actions的基本概念主要有以下幾個:

workflow (工作流程):持續集成一次運行的過程就是一個 workflow,一個項目可以有多個workflow。

job (任務):一個 workflow 由一個或多個 jobs 構成,含義是一次持續集成的運行,可以完成多個任務。

step(步驟):每個 job 由多個 step 構成,一步步完成,step 下有 name、uses、run、with 等,表示一個 action

action (動作:每個 step 可以依次執行一個或多個命令(action)。

註意點:
yml配置文件通常存放在項目中的.github/workflows 目錄,每個workflow都是.github/workflows目錄下的一個文件
workflow 文件採用 YAML 格式,文件名可以任意取,但是尾碼統一為 .yml。

如何執行部署的?

簡單說就是,我們通過配置yml文件來執行,當提交代碼到Github倉庫後,就可以自動部署到Github Pages上去。

因為Github 識別到配置文件後,會自動執行配置中的工作流(主要看配置自動的情況)

yml 配置文件一些概念說明

name:  CI
 
on:
  # 手動運行工作流程(workflow_dispatch 事件觸發器配置後可以在actions下手動運行工作流)
  workflow_dispatch:
  push:
    branches: 
      - master
jobs:
  # jobs的id
  build-and-deploy:
    # 指定伺服器的運行環境:最新版本ubuntu
    runs-on: ubuntu-latest
    steps:
      # 使用actions/checkout@v4 庫拉取代碼到 ubuntu 上
      - name: Checkout
        uses: actions/checkout@v4
 
      # 安裝 pnpm
      - name: Install pnpm
        uses: pnpm/action-setup@v2
        with:
          version: 8
 
      # 打包成靜態文件
      - name: Build
        run: pnpm install && pnpm build

我想大家看到上面的配置代碼,基本就知道意思了,這裡也簡單說下

常用的欄位及含義如下:

name :   workflow 的名稱 , 如果省略該欄位,預設為當前workflow的文件名

on:  指定觸發workflow的條件,通常是一些事件觸發器,比如:push,  workflow_dispatch、pull_request等

steps: 簡單說就是一個步驟的集合(裡面有多個小步驟),從上到下執行,它有幾個相關的選項

  1. name:每個小步驟的名稱(可自由定義)。
  2. uses:每個小步驟使用的 actions 庫名稱或路徑,Github Actions 允許我們使用別人寫好的 Actions 庫。
  3. run:  每個小步驟要執行的 shell 命令。
  4. with: 配置actions的額外參數。

2、理解Github Pages

Github Pages簡單說就是可以將我們托管在Github上的項目,免費發佈為對外的公共網頁,免去咱們花錢買伺服器。

我們可以使用 GitHub Pages 來展示一些開源項目、博客等等。

下麵開始說明如何去部署我們的博客站點

二、用Github Actions自動化部署到Github Pages

主要通過以下4個步驟完成部自動化署到

1、在Gtihub上創建倉庫和相關分支

2、配置github pages

3、編寫自動化部署yml文件

4、找到鏈接地址查看博客效果

1、在Gtihub上創建倉庫和相關分支

我們在Github上新建一個倉庫, 這裡我的項目叫vitePress-projectmaster主分支上提交我們的源代碼。

然後我們再新建一個分支叫deploy-pages,清空裡面的內容,這個分支用於存放pnpm build打包後的代碼。

 

2、配置Github Pages

到vitePress-project倉庫 -> Settings -> Pages 去設置Pages關聯的分支deploy-pages, 如圖

3、編寫自動化部署配置文件

有兩種方法可以創建自動化部署文件

1、直接去github倉庫/Actions下新建一個自動部署文件ci.yml(ci.yml名字可以自定義),然後修改內容即可

2、手動創建,如下所示

ci.yml配置內容如下

name: GitHub Actions Build and Deploy
 
on:
  # 手動運行工作流程(workflow_dispatch 事件觸發器配置後可以在actions下手動運行工作流)
  workflow_dispatch:
 
jobs:
  build-and-deploy:
    runs-on: ubuntu-latest  #指定伺服器的運行環境:最新版本ubuntu
    steps:
      # 使用actions/checkout@v4 庫拉取代碼到 ubuntu 上
      - name: Checkout
        uses: actions/checkout@v4
        with:
          # 根據網上資料查詢此處可以設置為 false。https://github.com/actions/checkout
          persist-credentials: false
 
      # 安裝 pnpm
      - name: Install pnpm
        uses: pnpm/action-setup@v2
        with:
          version: 8
 
      # 設置node的版本
      - name: Use Node.js
        # 使用 actions/setup-node@v3 庫安裝 nodejs,with 提供了一個參數 node-version 表示要安裝的 nodejs 版本
        uses: actions/setup-node@v3
        with:
          node-version: '18.x'
          cache: 'pnpm'
 
      # 打包成靜態文件
      - name: Build
        run: pnpm install && pnpm build
 
      # 部署到GitHub Pages - 也就是將打包內容發佈到GitHub Pages
      - name: Deploy
        # 使用別人寫好的 actions去部署(將打包文件部署到指定分支上)
        uses: JamesIves/[email protected]
        # 自定義環境變數
        with:
          # 指定倉庫:你要發佈的倉庫路徑名
          repository-name: msyuan/vitePress-project
          # 部署到 deploy-pages 分支,也就是部署後提交到那個分支
          branch: deploy-pages
          # 填寫打包好的目錄名稱路徑,本項目配置在根目錄
          folder: dist

用到的相關插件地址:

https://github.com/actions/checkout

https://github.com/pnpm/action-setup/

https://github.com/actions/setup-node

https://github.com/JamesIves/github-pages-deploy-action

 因為我們上面配置的是手動去運行工作流,所以需手動去執行部署,如圖所示

 

可以看到正在部署中….

4、找到鏈接地址查看博客效果

進入Settings -> Pages會看到博客鏈接地址:

預覽效果:https://msyuan.github.io/vitePress-project/

同時打包後的代碼也正常部署到deploy-pages分支上去了,到此已經完成部署工作

github項目地址:https://github.com/msyuan/vitePress-project

線上預覽效果:https://msyuan.github.io/vitePress-project

原文地址:http://www.qianduan8.com/2072.html

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 數據泄露對企業的影響是嚴重的,包括商業機密泄露、法律責任和信譽喪失。為了降低數據泄露的風險,NineData推出了SQL開發規範和用戶訪問量管理功能。用戶訪問量管理功能可以根據用戶的職責和工作需求,靈活配置訪問量,並對特定用戶單獨配置訪問量,並設置到期時間。這個功能適用於數據安全、法律合規和應急響應... ...
  • 1、華為官網介紹 2、OpenHarmony開源項目 3、技術架構 內核層 內核子系統:採用多內核(Linux內核或者LiteOS)設計,支持針對不同資源受限設備選用適合的OS內核 驅動子系統:驅動框架(HDF)是系統硬體生態開放的基礎,提供統一外設訪問能力和驅動開發、管理框架。 系統服務層 系統服 ...
  • 1 它是什麼(協程 和 Kotlin協程) 1.1 協程是什麼 維基百科:協程,英文Coroutine [kəru’tin] (可入廳),是電腦程式的一類組件,推廣了協作式多任務的子程式,允許執行被掛起與被恢復。 作為Google欽定的Android開發首選語言Kotlin,協程並不是 Kotli ...
  • 這裡給大家分享我在網上總結出來的一些知識,希望對大家有所幫助 前言 在前端開發中,有時候一些業務場景中,我們有需求要去實現excel的預覽和列印功能,本文在vue3中如何實現Excel文件的預覽和列印。 預覽excel 關於實現excel文檔線上預覽的做法,一種方式是通過講文檔里的數據處理成html ...
  • 在js中,js變數和JSON是兩個不同數據格式,兩者的儲存方式自然不相同。JSON格式是一種數據交換的規則,js變數則是javascript在程式需求場景中的數據表示。在js與不同語言的服務端進行數據交換過程中,js能夠有內置的方法將其變數轉化為JSON格式。 JSON.parse(data);// ...
  • 我們是袋鼠雲數棧 UED 團隊,致力於打造優秀的一站式數據中台產品。我們始終保持工匠精神,探索前端道路,為社區積累並傳播經驗價值。 本文作者:的盧 引入 在日常開發過程中,我們會使用很多性能優化的 API,比如像使用 memo、useMemo優化組件或者值,再比如使用 shouldComponent ...
  • 把Code Review 作為開發流程的必選項後,不代表Code Review這件事就可以執行的很好,因為Code Review 的執行,很大部分程度上依賴於審查者的認真審查,以及被審查者的積極配合,兩者缺一不可! ...
  • 寫在前面 react整體是函數式的思想,把組件設計成純組件,狀態和邏輯通過參數傳入,而vue的思想是響應式的,也就是基於是數據可變的,通過對每一個屬性建立Watcher來監聽, 當屬性變化的時候,響應式的更新對應的虛擬dom react的思路通過js來生成html, 所以設計了jsx,還有通過js來 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...