WriterSide 文档、接口自动编译并部署到GitPage

news2025/1/9 14:48:01

WriterSide 自动编译并部署到GitPage

- 1. GitHub 创建空仓库
- 2. 配置GitHub 仓库的编译部署方式
- 3. WriteSide 创建项目
- 4. 创建自动、编译部署配置文件
- 5. 自动编译、部署

1. GitHub 创建空仓库

在 GitHub 创建一个空的仓库
在这里插入图片描述
仓库创建成功后，记录仓库的远程地址

在这里插入图片描述
仓库地址需要修改为自己的仓库地址，比如我的仓库地址为

git remote add origin git@github.com:demodeom/write-auto-test.git

2. 配置GitHub 仓库的编译部署方式

设置仓库编译部署的方式为 GitHub Actions
在这里插入图片描述

3. WriteSide 创建项目

打开软件 WriteSide 创建项目
在这里插入图片描述
创建项目时，项目存储目录和项目目录名可以自定义

4. 创建自动、编译部署配置文件

编辑器左边的工具条，切换到 project 图表
文件展示方式选择 Peoject Files
创建自动编译部署配置文件
1. 在项目根目录创建目录 .github
2. 在 .github 目录下创建目录 workflows
3. 在 workflows 目录下创建文件 build-docs.yml

正确的 build-docs.yml 文件内容如下

name: Build documentation

on:
  push:
    branches: ["main"]
  workflow_dispatch:

permissions:
  id-token: write
  pages: write

env:
  INSTANCE: 'Writerside/in'
  ARTIFACT: 'webHelpIN2-all.zip'
  DOCKER_VERSION: '241.18775'