基于GitHub Actions 设计博文发布工作流

简介: 最近写了几篇文章,想对每次编写的文档做个版本控制。想到了Github, 将所有的文档备份到Github。不想每次手动运行hugo 编译和发布脚本,于是就有了下面的GithubActions工作流。借助GitHubActions完成对博客文章的自动化发布部署。

image.png

最近写了几篇文章,想对每次编写的文档做个版本控制。想到了Github, 将所有的文档备份到Github。不想每次手动运行hugo 编译和发布脚本,于是就有了下面的GithubActions工作流。借助GitHubActions完成对博客文章的自动化发布部署。

版本库

首先,我们在Github上面创建一个仓库,用于存储博客的数据。静态博客推荐使用Hugo,非常简单。使用Markdown语法,官方提供了很多不错的主题模板。


image.png


这里我是用主干main 分支存储项目的代码, 单独创建一个分支存储编译后的静态HTML资源文件。我们切换到另外一个分支看下:


image.png


工作面板

新建一个工作板可以自定义状态,简单的将每次的博客优化需求记录在这里。这里的每一项任务都可以转换为issue,提交代码可以对应的issue关联。


image.png


CI/CD集成与发布

使用Github actions 作为构建。设置在main分支提交代码即构建。

name: github pages
on:
  push:
    branches: [ main ]

签出主干分支代码,删除pages-git 分支(该分支存放静态文件,需要频繁更新)。

jobs:
  deploy:
    runs-on: ubuntu-18.04
    steps:
      - uses: actions/checkout@v2
        with:
          submodules: true  # Fetch Hugo themes (true OR recursive)
          fetch-depth: 0    # Fetch all history for .GitInfo and .Lastmod
      - name: Delete branch
        uses: dawidd6/action-delete-branch@v3
        with:
          github_token: ${{ secrets.GIT_TOKEN }}
          branches: "pages-git"


hugo --minify 生成静态文件public 目录。

- name: Setup Hugo
        uses: peaceiris/actions-hugo@v2
        with:
          hugo-version: '0.74.2'
          # extended: true
      - name: Build
        run: |
          hugo --minify
          ls public
          tar zcf ${version}-public.tar.gz public
          ls

删除当前目录除public目录外的所有文件, 然后将public目录文件移动到当前目录

- name: commit
        run: |
          rm -fr archetypes
          rm -fr content
          rm -fr demo
          rm -fr static
          rm -fr themes
          rm -fr .DS_Store
          rm -fr 1.1.0-public.tar.gz
          rm -fr README.md
          rm -fr config.toml
          mv public/* ./
          sleep 3
          ls -l 
          rm -fr public 
          git config --global user.email xxx@qq.com
          git config --global user.name cccc
          git add .
          git commit -m "update" -a

提交当前的工作目录到pages-git 分支。(到此pages-git分支已经存储了更新后的静态文件)

- name: Push changes
        uses: ad-m/github-push-action@master
        with:
          github_token: ${{ secrets.GIT_TOKEN }}
          branch: "pages-git"

github pages访问太慢了, 准备使用国内的gitee pages服务。在gitee创建一个仓库。最后一部分代码是将当前pages-git 分支代码镜像到gitee 项目的pages-git分支。

- name: 'get code '
        uses: actions/checkout@v2
        with:
          submodules: true  # Fetch Hugo themes (true OR recursive)
          fetch-depth: 0    # Fetch all history for .GitInfo and .Lastmod
          ref: "pages-git"
      - name: 'Mirror to gitee'
        uses: pixta-dev/repository-mirroring-action@v1
        with:
          target_repo_url:
            git@gitee.com:devopsgo/devopsgo.git
          ssh_private_key:
            ${{ secrets.GIT_PRIVATE_KEY }}

到此,代码已经同步到了Gitee Pages。接下来触发Gitee Pages 服务更新。(指定静态目录分支部署)


image.png



浏览器访问devopsgo.gitee.io 就可以访问了。到此发布完成了。

image.png


工作流已经创建好了, 最后每次发布博文的时候。使用vscode编写markdown文档,然后本地hugo serve 调试。完成后提交到主干分支,随后GitHub Actions 就会运行CI/CD,自动发布。

image.png



image.png


image.png


扩展参考:SSH发布到云主机

# - name: copy file via ssh password
      #   uses: appleboy/scp-action@master
      #   with:
      #     host: ${{ secrets.SSH_HOST }}
      #     username: ${{ secrets.SSH_USER }}
      #     password: ${{ secrets.SSH_PASSWD }}
      #     port: 22
      #     source: "./${{env.version}}-public.tar.gz"
      #     target: "/opt/"
      # - name: executing remote ssh commands using password
      #   uses: appleboy/ssh-action@master
      #   with:
      #     host: ${{ secrets.SSH_HOST }}
      #     username: ${{ secrets.SSH_USER }}
      #     password: ${{ secrets.SSH_PASSWD }}
      #     port: 22
          # script: |
          #   rm -fr /var/www/newdevops/*
          #   mv /opt/${{ env.version }}-public.tar.gz /var/www/newdevops/
          #   cd /var/www/newdevops/ && tar zxf ${{ env.version }}-public.tar.gz
          #   mv public/* ./  && rm -fr public 
          #   chown nginx:nginx /var/www/ -R
          #   systemctl reload nginx

到此,整个工作流就完成了。望对你有所帮助!

目录
相关文章
|
监控 安全 机器人
通过GitHub Actions给微信公众测试号和钉钉群定时推送消息(Python)
通过GitHub Actions给微信公众测试号和钉钉群定时推送消息(Python)
242 0
|
存储 Ubuntu 持续交付
GitHub Actions 指南(上)
GitHub Actions 指南
168 0
|
2月前
|
JavaScript API 开发工具
使用GitHub Actions自动发布electron多端安装程序
使用GitHub Actions自动发布electron多端安装程序
57 8
利用 GitHub Actions 自动化你的软件开发流程
GitHub Actions 是由 GitHub 提供的自动化工具,可让你在仓库中触发和执行自动化工作流程,如自动运行测试和部署应用。其核心概念包括工作流程(定义在 YAML 文件中的一系列自动化步骤)、作业和步骤。本文将指导你如何设置和使用 GitHub Actions,并提供实用的自动化示例,帮助你提高开发效率和代码质量。通过简单的配置文件,你可以实现自动运行测试、部署应用甚至自动合并 Pull Requests。
利用 GitHub Actions 自动化你的软件开发流程
在现代软件开发中,自动化是提升效率与质量的关键。GitHub Actions 作为 GitHub 的强大自动化工具,允许你在仓库中自动执行多种任务,如测试、打包、部署代码及自动合并 Pull Requests。本文介绍了 GitHub Actions 的核心概念、设置方法及其实用示例,帮助你快速上手并优化开发流程。通过 YAML 文件定义的工作流程可显著提高工作效率和代码质量。
|
3月前
|
开发者
利用 GitHub Actions 自动化你的软件开发流程
在快速发展的软件开发环境中,自动化对于提升效率与质量至关重要。GitHub Actions 作为一款强大的工具,能帮助开发者实现从自动运行测试到部署应用等工作的自动化。本文详细介绍了 GitHub Actions 的核心概念、设置方法及实际应用示例,如自动测试、部署和合并 Pull Requests,助力提升开发流程的自动化水平。
利用 GitHub Actions 自动化你的软件开发流程
GitHub Actions 是 GitHub 提供的自动化工具,可在仓库中触发和执行工作流程,包括自动运行测试、部署应用等。其核心概念包括工作流程(Workflow)、作业(Job)和步骤(Step),均定义在 YAML 文件中。本文将指导你如何设置和使用 GitHub Actions,并提供自动运行测试、部署应用及合并 Pull Requests 的示例,帮助提高开发效率和代码质量。
|
4月前
|
Java Spring 传感器
AI 浪潮席卷,Spring 框架配置文件管理与环境感知,为软件稳定护航,你还在等什么?
【8月更文挑战第31天】在软件开发中,配置文件管理至关重要。Spring框架提供强大支持,便于应对不同环境需求,如电商项目的开发、测试与生产环境。它支持多种格式的配置文件(如properties和YAML),并能根据环境加载不同配置,如数据库连接信息。通过`@Profile`注解可指定特定环境下的配置生效,同时支持通过命令行参数或环境变量覆盖配置值,确保应用稳定性和可靠性。
73 0
|
4月前
|
Devops 持续交付 开发者
.NET自动化之旅:是Azure DevOps还是GitHub Actions能够打造完美的CI/CD流水线?
【8月更文挑战第28天】在现代软件开发中,持续集成(CI)与持续部署(CD)是提升代码质量和加速交付的关键实践。对于 .NET 应用,Azure DevOps 和 GitHub Actions 等工具可高效构建 CI/CD 流水线,提升开发效率并确保软件稳定可靠。Azure DevOps 提供一站式全流程管理,支持 YAML 定义的自动化构建、测试和部署;GitHub Actions 则以简洁灵活著称,适用于 .NET 项目的自动化流程。选择合适的工具可显著提高开发效率并确保高质量标准。
29 0
|
4月前
|
数据采集 JSON 小程序
零成本 API 服务搭建,用 GitHub Actions 自动爬取文章?
本着将成本降到最低,我目前做的应用或小程序都是单机的,也就是不用请求接口,只要一上架就没有任何支出。但是写死的数据毕竟有限,应用的内容单一无法紧跟时事热点,每次打开一个样,自然就没有留存。遇到有错字啥还要更新版本,那有没有方法既能丰富应用内容,又不用增加成本呢?
40 0