jbangdev/jbang-action

JBang容器（Docker与GitHub Action）

镜像概述和主要用途

本容器旨在使用jbang工具快速简便地运行基于Java的脚本。可直接通过Docker使用，或作为GitHub Action集成到CI/CD流程中。镜像源代码同步自https://github.com/jbangdev/jbang/blob/HEAD/src/jreleaser/distributions/jbang-action/docker/%E4%BB%93%E5%BA%93%EF%BC%8C%E4%BC%9A%E5%9C%A8jbang%E6%AF%8F%E6%AC%A1%E6%A0%87%E7%AD%BE/%E7%89%88%E6%9C%AC%E5%8F%91%E5%B8%83%E6%97%B6%E6%9B%B4%E6%96%B0%E3%80%82

核心功能和特性

• 快速执行Java脚本：基于jbang工具，无需复杂Java环境配置即可运行Java脚本
• 多环境支持：同时支持Docker本地运行和GitHub Action云端集成
• 灵活参数配置：支持传递jbang自身参数、脚本参数及信任主机配置
• 多镜像源：提供Docker Hub和Quay.io两种镜像源选择
• 缓存优化：支持缓存jbang仓库目录，加速重复执行

使用场景和适用范围

• 本地开发环境：快速运行Java脚本，验证脚本逻辑或工具功能
• CI/CD流程集成：在GitHub Actions中执行自动化任务（如创建Issue、生成报告、部署工具等）
• 轻量级Java工具运行：无需预安装Java环境，通过容器化方式执行Java脚本工具

详细使用方法和配置说明

Docker使用

Docker Hub镜像

通过Docker Hub拉取镜像并运行脚本：

bash
docker run -v `pwd`:/ws --workdir=/ws jbangdev/jbang-action helloworld.java

• -v \pwd`:/ws：将当前目录挂载到容器内的/ws`目录（工作目录）
• --workdir=/ws：设置容器工作目录为/ws，确保脚本路径正确解析
• helloworld.java：要执行的Java脚本（支持本地文件、URL或jbang别名）

Quay.io镜像

通过Quay.io拉取镜像并运行脚本：

bash
docker run -v `pwd`:/ws --workdir=/ws quay.io/jbangdev/jbang-action helloworld.java

参数说明同上。

GitHub Action使用

输入参数（Inputs）

输出参数（Outputs）

无输出参数。

示例用法

假设项目根目录下存在jbang脚本createissue.java，以下是在GitHub Actions中运行该脚本的配置示例：

yaml
on: [push]

jobs:
  jbang:
    runs-on: ubuntu-latest
    name: 运行jbang脚本
    steps:
    - name: 检出代码
      uses: actions/checkout@v1
    - uses: actions/cache@v1
      with:
        path: /root/.jbang
        key: ${{ runner.os }}-jbang-${{ hashFiles('**/*.java') }}
        restore-keys: |
            ${{ runner.os }}-jbang-
    - name: 执行jbang脚本
      uses: jbangdev/jbang-action@v0.132.1
      with:
        script: createissue.java
        scriptargs: "my world"
      env:
        JBANG_REPO: /root/.jbang/repository  # 指定jbang仓库路径，用于缓存
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # 传递GitHub Token给脚本

源代码

https://github.com/jbangdev/jbang-action