elastio/js_ci

GitHub Actions Shell镜像文档

镜像概述

该镜像专为GitHub Actions设计，提供基础shell执行环境，旨在作为CI/CD工作流中的运行时，支持在GitHub Actions工作流中执行shell命令、脚本及自动化任务，简化工作流配置并确保命令执行环境的一致性。

核心功能与特性

• 基础shell环境：内置标准shell（如bash），支持常见shell命令和语法
• 轻量级设计：镜像体积优化，适合CI/CD场景快速拉取和启动
• GitHub Actions兼容：针对GitHub Actions运行环境优化，确保与工作流配置无缝集成
• 跨平台支持：兼容GitHub Actions的主流运行环境（如Ubuntu、Windows、macOS runners，具体取决于镜像架构）

使用场景

• GitHub Actions工作流中需要执行shell命令或脚本的步骤
• CI/CD流程中的环境准备、依赖安装、构建验证等命令执行场景
• 需要在统一shell环境中运行跨步骤脚本的自动化任务

使用方法与配置说明

在GitHub Actions工作流中使用

在GitHub Actions的 workflow 文件（.github/workflows/*.yml）中，通过 container 字段或 image 参数指定该镜像作为步骤的运行环境。

基础使用示例

yaml
name: Example Workflow
on: [push]
jobs:
  run-commands:
    runs-on: ubuntu-latest
    container:
      image: docker.xuanyuan.run/<镜像名称>  # 替换为实际镜像名称
    steps:
      - name: Run shell command
        run: |
          echo "Hello from GitHub Actions shell"
          ls -la
          # 执行其他需要的shell命令

作为步骤环境使用

yaml
steps:
  - name: Use shell image
    uses: docker://<镜像名称>  # 替换为实际镜像名称
    with:
      args: echo "Running command in shell image"

配置说明

该镜像通常无需额外配置，默认提供基础shell环境。如需自定义，可通过以下方式：

• 环境变量：通过GitHub Actions的 env 字段设置环境变量，供shell命令使用

  yaml
  steps:
    - name: Run with env
      env:
        EXAMPLE_ENV: "value"
      run: echo "Environment variable: $EXAMPLE_ENV"
  

• 命令参数：在 run 字段或 args 中指定具体shell命令或脚本路径

注意事项

• 确保镜像名称与实际使用的Docker镜像标签一致（如Docker Hub或私有仓库地址）
• 根据GitHub Actions runner的操作系统选择对应架构的镜像版本（如linux/amd64）
• 轻量级设计可能不含部分系统工具，如需特殊依赖，可在工作流中通过shell命令安装

总结

该镜像为GitHub Actions工作流提供了便捷的shell执行环境，通过简化命令执行流程和确保环境一致性，助力高效CI/CD自动化任务的实现。