能否将工作流日志实时推送至自有Spring Boot Web服务器？

核心思路 #

GitHub Actions工作流本身不直接支持WebSocket推送日志，但可以通过自定义脚本+WebSocket客户端结合的方式实现，同时配合Spring Boot的WebSocket服务端接收实时日志。

具体步骤 #

1. 搭建Spring Boot WebSocket服务端 #

在你的Spring Boot项目中配置WebSocket端点，用于接收日志：

• 先添加WebSocket依赖（Maven示例）：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-websocket</artifactId>
</dependency>

• 配置WebSocket处理器与端点：

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        // 定义日志接收端点，允许跨域可根据实际情况调整
        registry.addHandler(logWebSocketHandler(), "/github-workflow-logs")
                .setAllowedOrigins("*");
    }

    @Bean
    public WebSocketHandler logWebSocketHandler() {
        return new LogWebSocketHandler();
    }
}

public class LogWebSocketHandler extends TextWebSocketHandler {
    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        // 处理接收到的日志，比如存储到数据库或实时展示
        String logContent = message.getPayload();
        System.out.println("收到工作流日志：" + logContent);
        // 可选：给客户端发送接收确认
        session.sendMessage(new TextMessage("日志已接收"));
    }
}

2. 在GitHub Actions工作流中添加日志推送逻辑 #

在你的.github/workflows/xxx.yml文件里，添加步骤捕获工作流日志并通过WebSocket实时推送：

• 这里用Node.js的ws库作为WebSocket客户端，示例如下：

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: 拉取代码
        uses: actions/checkout@v4

      - name: 配置Node.js环境
        uses: actions/setup-node@v4
        with:
          node-version: '20'

      - name: 安装WebSocket客户端依赖
        run: npm install ws

      - name: 执行工作流并推送实时日志
        run: |
          # 替换为你的实际工作流命令，捕获输出并通过WebSocket发送
          your-workflow-command 2>&1 | node -e "
          const WebSocket = require('ws');
          const ws = new WebSocket('ws://你的SpringBoot服务器地址:端口/github-workflow-logs');
          ws.on('open', () => {
            process.stdin.on('data', (data) => {
              const logLine = data.toString().trim();
              if (logLine) {
                ws.send(logLine);
              }
            });
          });
          ws.on('error', (err) => {
            console.error('WebSocket连接失败:', err);
            process.exit(1);
          });
          "

• 注意替换your-workflow-command为实际工作流执行命令，你的SpringBoot服务器地址:端口为你的服务器实际地址。

3. 不稳定连接的替代方案 #

如果GitHub Runner和你的服务器之间WebSocket连接不稳定，可以考虑：

• 先将工作流日志输出到文件，再通过HTTP POST批量发送到Spring Boot接口，但会损失实时性。
• 用GitHub的actions/upload-artifact将日志上传为工件，Spring Boot服务器定期拉取，实时性同样会受影响。

注意事项 #

• 确保你的Spring Boot服务器能被GitHub Runner访问（私有网络环境需配置端口映射或内网穿透）。
• 建议给WebSocket连接添加身份验证（比如请求参数携带token），防止非法连接。
• 若日志包含敏感信息，需使用wss://加密传输。

内容的提问来源于stack exchange，提问作者Trần Phước Lộc