mono_repo.dart 项目教程

mono_repo.dart 项目教程

mono_repo.dart Allows easy management of repositories with multiple Dart packages 项目地址: https://gitcode.com/gh_mirrors/mo/mono_repo.dart

1. 项目的目录结构及介绍

mono_repo.dart 是一个用于管理包含多个 Dart 包的单个源代码仓库的工具。以下是该项目的目录结构及其介绍：

mono_repo.dart/
├── AUTHORS
├── LICENSE
├── README.md
├── analysis_options.yaml
├── mono_repo.yaml
├── pubspec.yaml
├── tool/
│   └── ci.sh
├── test_flutter_pkg/
│   ├── mono_pkg.yaml
│   └── pubspec.yaml
├── test_pkg/
│   ├── mono_pkg.yaml
│   └── pubspec.yaml
└── github/
    └── workflows/
        ├── dart.yml
        └── lint.yml

目录结构介绍

• AUTHORS: 项目作者列表。
• LICENSE: 项目许可证文件，采用 BSD-3-Clause 许可证。
• README.md: 项目介绍和使用说明。
• analysis_options.yaml: 代码分析配置文件，用于配置代码风格和静态分析规则。
• mono_repo.yaml: 项目根目录的配置文件，用于管理多个 Dart 包的 CI 配置。
• pubspec.yaml: 项目的依赖管理文件，定义了项目的依赖和元数据。
• tool/ci.sh: CI 脚本，用于生成和运行 CI 配置。
• test_flutter_pkg/ 和 test_pkg/: 示例包目录，包含 mono_pkg.yaml 和 pubspec.yaml 文件，用于配置和管理单个 Dart 包。
• github/workflows/: GitHub Actions 的工作流配置文件，用于定义 CI/CD 流程。

2. 项目的启动文件介绍

mono_repo.dart 项目的启动文件主要是 tool/ci.sh 脚本。该脚本用于生成和运行 CI 配置。以下是启动文件的介绍：

tool/ci.sh

该脚本的主要功能是生成和运行 CI 配置。它通过调用 mono_repo 工具来生成 GitHub Actions 的工作流配置文件，并执行相应的 CI 任务。

使用方法

# 生成 CI 配置文件
./tool/ci.sh generate

# 运行 CI 任务
./tool/ci.sh run

3. 项目的配置文件介绍

mono_repo.dart 项目中有多个配置文件，用于管理项目的不同方面。以下是主要配置文件的介绍：

mono_repo.yaml

该文件位于项目根目录，用于配置整个仓库的 CI 设置。它定义了 CI 提供者（如 GitHub Actions）的配置，以及如何管理多个 Dart 包的测试和发布流程。

示例配置

# 启用 GitHub Actions
github:
  # 配置触发事件
  on:
    push:
      branches:
        - main
        - master
    pull_request:
  cron: '0 0 * * 0'  # 每周日 00:00 UTC 触发

# 自验证选项，确保配置文件是最新的
self_validate: analyze

# 合并阶段配置
merge_stages:
  - analyze

mono_pkg.yaml

该文件位于每个 Dart 包的目录中，用于配置单个包的 CI 设置。它定义了如何运行测试、代码分析等任务。

示例配置

# 定义 SDK 版本
sdk:
  - dev

# 定义 CI 阶段
stages:
  - analyze:
      - analyze
      - format
  - unit_test:
      - test

pubspec.yaml

该文件位于每个 Dart 包的目录中，用于定义包的依赖和元数据。它是 Dart 包的标准配置文件。

示例配置

name: example_package
version: 1.0.0
description: 这是一个示例包
dependencies:
  flutter:
    sdk: flutter

通过以上配置文件，mono_repo.dart 项目能够有效地管理多个 Dart 包的 CI 流程和依赖关系。

mono_repo.dart Allows easy management of repositories with multiple Dart packages 项目地址: https://gitcode.com/gh_mirrors/mo/mono_repo.dart