Setup MSYS2 项目技术文档

Setup MSYS2 项目技术文档

安装指南

系统要求

• Windows 操作系统
• 确保已安装 Git 和 Curl

安装步骤

1. 下载 MSYS2：

   • 访问 MSYS2 官方网站 下载最新版本的 MSYS2 安装包。
   • 运行安装包，按照提示完成安装。

2. 配置环境变量：

   • 将 MSYS2 的安装路径（如 C:\msys64）添加到系统的 PATH 环境变量中。

3. 更新 MSYS2：

   • 打开 MSYS2 终端，运行以下命令更新系统：

     pacman -Syu
     

4. 安装必要的包：

   • 根据项目需求，安装所需的包。例如：

     pacman -S git curl
     

项目的使用说明

基本使用

1. 启动 MSYS2 终端：

   • 在 Windows 开始菜单中找到并启动 MSYS2 终端。

2. 运行命令：

   • 在终端中输入命令，例如：

     uname -a
     

在 GitHub Actions 中使用

1. 配置 GitHub Actions 工作流：

   • 在项目的 .github/workflows 目录下创建或编辑一个 YAML 文件，例如 main.yml。
   • 添加以下内容以使用 setup-msys2 动作：

     - uses: msys2/setup-msys2@v2
     

2. 运行脚本：

   • 在 GitHub Actions 工作流中运行 MSYS2 脚本：

     - shell: msys2 {0}
       run: |
         uname -a
     

3. 使用特定命令：

   • 从 cmd/powershell 脚本中执行特定命令：

     - shell: powershell
       run: msys2 -c 'uname -a'
     

默认 shell

• 可以将 msys2 设置为默认 shell 以减少冗余：

  defaults:
    run:
      shell: msys2 {0}
  steps:
  - uses: msys2/setup-msys2@v2
    with:
      update: true
      install: >-
        curl
        git
  - uses: actions/checkout@v4
  

项目API使用文档

选项

msystem

• 类型：string
• 允许值：MSYS | MINGW64 | MINGW32 | UCRT64 | CLANG32 | CLANG64 | CLANGARM64
• 默认值：MINGW64
• 说明：设置默认的 MSYS2 环境。

update

• 类型：boolean
• 默认值：false
• 说明：是否更新已安装的包。

install

• 类型：string
• 说明：安装额外的包。

pacboy

• 类型：string
• 说明：使用 pacboy 安装包。

platform-check-severity

• 类型：string
• 允许值：warn | fatal
• 默认值：fatal
• 说明：检查运行器操作系统是否为 Windows。

输出

msys2-location

• 说明：MSYS2 安装位置的绝对路径。

项目安装方式

使用 GitHub Actions

• 在 GitHub Actions 工作流中使用 setup-msys2 动作来设置 MSYS2 环境。

手动安装

• 下载并安装 MSYS2，配置环境变量，更新系统并安装必要的包。

通过以上步骤，您可以顺利安装和使用 MSYS2 环境，并在 GitHub Actions 中进行自动化构建和测试。