Skip to content

🏗️ BuildSatis

使用指定配置文件构建 Satis 仓库。等价于运行 composer satis build <configPath> [outputDir]

何时使用

CreateSatisConfigInitSatis 生成配置后调用,生成可供客户端引用的 packages.json 与包归档产物。

签名

go
func (c *Composer) BuildSatis(configPath string, outputDir string) (string, error)

参数

参数类型说明
configPathstringSatis 配置文件路径,例如 satis/satis.json
outputDirstring输出目录;传空字符串则使用配置中的 output-dir

返回值

返回值类型说明
第一返回值string构建命令的输出
第二返回值error执行失败时返回

前置依赖

该方法依赖 satis 可执行文件已安装并在 PATH 中。Satis 通常以 composer global require composer/satis 安装。

示例

go
package main

import (
	"fmt"
	"log"

	"github.com/scagogogo/composer-skills/pkg/composer"
)

func main() {
	comp, err := composer.New(composer.DefaultOptions())
	if err != nil {
		log.Fatalf("初始化失败: %v", err)
	}

	output, err := comp.BuildSatis("satis/satis.json", "public")
	if err != nil {
		log.Fatalf("构建 Satis 失败: %v", err)
	}
	fmt.Println(output)
}

进阶

  • 构建前需先有配置文件,参见 CreateSatisConfigInitSatis
  • 想启用归档产物(zip/tar)可先用 EnableSatisArchive 修改配置。
  • 调整最小稳定性用 UpdateSatisStability

基于 MIT 许可证发布