Deploying vuepress blog with GitHub actions

lastknightcoder 2021-06-18 05:55:27
deploying vuepress blog github actions


Follow me VuePress There's more and more in blogs , Every time I pack a project and upload it to Github It's going to take a while on the road , I know in some articles before Github Actions Can help me deploy projects automatically , Just try it today .

In the use of Github Actions before , The deployment process is like this :

  • Write an article
  • Generating static files
  • Deploy static files to Github Page On

Used Github Actions after , The process becomes :

  • Write an article
  • Submit the article to Github On

The configuration file

And then we'll show you how to use this weapon . First, you need to create a new... Under your project .github/workflows/ Folder , And then workflows New under folder xxx.yml file , This file name is arbitrary , But it must be YAML file , For example, I added a new file named deploy.yml, Give me my configuration ( Removed some personalized configuration )

name: Build and Deploy
on:
  push:
    branches:
      - master
jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout 
        uses: actions/[email protected]

      - name: Install and Build  
        run: |
          npm install
          npm run build

      - name: Deploy 
        uses: JamesIves/[email protected]
        with:
          BRANCH: gh-pages
          FOLDER: docs/.vuepress/dist
          ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}

When you turn to Github When code is submitted , It will automatically detect .github/workflows/ Catalog , If there is a configuration , According to your configuration workflow Automatically deploy projects .

From the configuration above , It is mainly divided into three departments :

  • name: This workflow The name of , Take whatever you like

  • on: The trigger condition

    on:
      push:
        branches:
          - master

    When we say to master Branch push It will trigger the workflow

  • jobs: Define the tasks to be performed , For example, we defined a task above build-and-deploy, Each task contains the following configuration

    • runs-on: The virtual machine environment needed to run ,Github It provides us with the following environment

      • ubuntu-latest, ubuntu-18.04 or ubuntu-16.04
      • windows-latest, windows-2019 or windows-2016
      • macOS-latest or macOS-10.14

      Here we chose ubuntu-latest

    • steps: The steps to run the task

And then we'll explain the steps we're going to take , Our steps include three steps , The first step is to pull the code of the main branch

- name: Checkout 
  uses: actions/[email protected]

The second step , Run two commands npm install And npm run build

- name: Install and Build  
  run: |
    npm install
    npm run build

The third step , take The generated static folder is deployed to gh-pages On the branch

- name: Deploy 
  uses: JamesIves/[email protected]
  with:
    BRANCH: gh-pages
    FOLDER: docs/.vuepress/dist
    ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}

Configure key

Use Github Actions Is the need to ACCESS-TOKEN, Now that they can use it Github 了 , I'm sure I know how this thing came into being , If not , Request reference Official documents .

We need to be in the warehouse Setting Choose from Secrets

image-20210531185033956

Click... On the top right New repository secret

image-20210531185129280

Name It must be written as ACCESS_TOKEN,Value It's your token, When you're done, click Add secret, If there's no problem filling in , After clicking, you will be prompted to add successfully .

Every time you're going to Vuepress Project submitted to Github Last time ,Github Will automatically help you deploy the project .

image-20210531185615412

stay Actions You can see the deployment of the project in this option , As you can see above, I tried three times , The third time it worked , The first two were stepping on the pit , Here are the two pits I stepped on .

Step on the pit

stay VuePress On the official website , The build script command given is

npm run docs:build

I feel in trouble , Change it to npm run build, So the first time you run it , Just remind me that I don't have this script

image-20210531190036475

I changed it , So if the script you build doesn't match mine , It still needs to be changed .

Another pit , When it's configured , I'll take my VuePress Blog submitted to Github, But after running for a while, there was an error

image-20210531190224283

Judging from the type of error, it seems to be super memory , And then after my search , stay Github One of the issue Found in the terms of settlement , Add the following environment variables

env:
  NODE_OPTIONS: '--max_old_space_size=4096'

The changed configuration file is as follows

name: Build and Deploy
on:
  push:
    branches:
      - master
jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout 
        uses: actions/[email protected]

      - name: Install and Build  
        run: |
          npm install
          npm run build
        env:
          NODE_OPTIONS: '--max_old_space_size=4096'

      - name: Deploy 
        uses: JamesIves/[email protected]
        with:
          BRANCH: gh-pages
          FOLDER: docs/.vuepress/dist
          ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
版权声明
本文为[lastknightcoder]所创,转载请带上原文链接,感谢
https://qdmana.com/2021/05/20210531210706969i.html

  1. HTML + CSS + JavaScript to achieve cool Fireworks (cloud like particle text 3D opening)
  2. HTML + CSS + JavaScript realizes 520 advertising love tree (including music), which is necessary for programmers to express themselves
  3. Solve the problem of Web front-end deployment server (it can be deployed online without a server)
  4. HTML + CSS + JS make wedding countdown web page template (520 / Tanabata Valentine's Day / programmer advertisement)
  5. What else can driverless minibus do besides "Park connection"?
  6. Cloud native leads the era of all cloud development
  7. NRM mirror source management tool
  8. Bring it to you, flex Jiugong
  9. Lolstyle UI component development practice (II) -- button group component
  10. Deconstruction assignment in ES6
  11. Luo 2 peerless Tang clan was officially launched. The official gave a key point, and the broadcast time was implied
  12. 20初识前端HTML(1)
  13. 当新零售遇上 Serverless
  14. 20 initial knowledge of front-end HTML (1)
  15. When new retail meets serverless
  16. [golang] - go into go language lesson 5 type conversion
  17. [golang] - go into go language lesson 6 conditional expression
  18. HTML5(八)——SVG 之 path 详解
  19. HTML5 (8) -- detailed explanation of SVG path
  20. 需要开通VIP以后页面内容才能复制怎么办?控制台禁用javascript即可
  21. Web前端|CSS入门教程(超详细的CSS使用讲解,适合前端初学者)
  22. 实践积累 —— 用Vue3简单写一个单行横向滚动组件
  23. Serverless 全能选手,再下一城
  24. What if you need to open a VIP to copy the page content? Just disable JavaScript on the console
  25. Web front end | CSS introductory tutorial (super detailed CSS explanation, suitable for front-end beginners)
  26. Practice accumulation - write a single line horizontal scroll component simply with vue3
  27. Dili Reba is thin again. She looks elegant and high in a strapless hollow skirt, and her "palm waist" is beautiful to a new height
  28. Serverless all-round player, next city
  29. The difference between MySQL semi synchronous replication and lossless semi synchronous replication
  30. Vue表单设计器的终极解决方案
  31. The ultimate solution for Vue form designer
  32. Nginx从理论到实践超详细笔记
  33. Yu Shuxin's red backless swimsuit is split to the waist and tail, with a concave convex figure and excessive color matching, and his face is white to dazzling
  34. Nginx ultra detailed notes from theory to practice
  35. 【动画消消乐|CSS】086.炫酷水波浪Loading过渡动画
  36. typecho全站启用https
  37. CCTV has another popular employee. The off-site interpretation is very professional, and the appearance ability is no less than that of Wang Bingbing
  38. [animation Xiaole | CSS] 086. Cool water wave loading transition animation
  39. Enable HTTPS in Typecho
  40. 50天用JavaScript完成50个web项目,我学到了什么?
  41. 根据JavaScript中原生的XMLHttpRequest实现jQuery的Ajax
  42. What have I learned from completing 50 web projects with JavaScript in 50 days?
  43. "My neighbor doesn't grow up" has hit the whole network. There are countless horse music circles, and actor Zhou Xiaochuan has successfully made a circle
  44. 根据JavaScript中原生的XMLHttpRequest实现jQuery的Ajax
  45. Implement the Ajax of jQuery according to the native XMLHttpRequest in JavaScript
  46. Implement the Ajax of jQuery according to the native XMLHttpRequest in JavaScript
  47. 30 + women still wear less T-shirts and jeans. If they wear them like stars, they will lose weight
  48. 数栈技术分享前端篇:TS,看你哪里逃~
  49. Several stack technology sharing front end: TS, see where you escape~
  50. 舍弃Kong和Nginx,Apache APISIX 在趣链科技 BaaS 平台的落地实践
  51. Abandon the landing practice of Kong and nginx, Apache apisik on the baas platform of fun chain technology
  52. 浪迹天涯king教你用elementui做复杂的表格,去处理报表数据(合并表头,合并表体行和列)
  53. 前端HTML两万字图文大总结,快来看看你会多少!【️熬夜整理&建议收藏️】
  54. Wandering around the world king teaches you to use elementui to make complex tables and process report data (merge header, merge table body rows and columns)
  55. 路由刷新数据丢失 - vuex数据读取的问题
  56. Front end HTML 20000 word graphic summary, come and see how much you can【 Stay up late to sort out & suggestions]
  57. Route refresh data loss - vuex data reading problem
  58. Systemctl系统启动Nginx服务脚本
  59. Systemctl system startup nginx service script
  60. sleepless