Magic Nix Cache Action 使用教程

Magic Nix Cache Action 使用教程

magic-nix-cache-action Save 30-50%+ of CI time without any effort or cost. Use Magic Nix Cache, a totally free and zero-configuration binary cache for Nix on GitHub Actions. 项目地址: https://gitcode.com/gh_mirrors/ma/magic-nix-cache-action

1. 项目目录结构及介绍

Magic Nix Cache Action 是一个开源项目，旨在为 Nix 用户在 GitHub Actions 中提供零配置的二进制缓存服务。以下是项目的目录结构及各部分的功能介绍：

.
├── .github
│   └── workflows
│       └── example.yml  # 示例 GitHub 工作流文件
├── dist
├── src
├── .editorconfig
├── .envrc
├── .eslintrc.json
├── .gitattributes
├── .gitignore
├── .prettierignore
├── LICENSE
├── README.md
├── action.yml          # GitHub Action 的配置文件
├── flake.lock
├── flake.nix
├── package.json
├── pnpm-lock.yaml
├── prettier.config.cjs
├── shell.nix
├── tsconfig.json
├── tsup.config.ts

• .github/workflows/example.yml：示例 GitHub 工作流文件，展示了如何集成 Magic Nix Cache Action。
• dist：编译后的文件存放目录。
• src：源代码目录。
• .editorconfig：编辑器配置文件，用于统一不同开发者的代码风格。
• .envrc：环境变量配置文件。
• .eslintrc.json：ESLint 配置文件，用于代码质量检查。
• .gitattributes：Git 属性配置文件，用于指定不同文件的 Git 行为。
• .gitignore：Git 忽略文件，用于指定不需要提交到版本控制系统的文件。
• .prettierignore：Prettier 忽略文件，用于指定不需要格式化的文件。
• LICENSE：项目许可证文件，本项目采用 MIT 许可证。
• README.md：项目说明文件，介绍了项目的使用方法。
• action.yml：GitHub Action 的配置文件，定义了 Action 的输入参数和行为。
• flake.lock 和 flake.nix：Nix 的包管理锁定文件。
• package.json：Node.js 项目配置文件。
• pnpm-lock.yaml：Pnpm 包管理器锁定文件。
• prettier.config.cjs：Prettier 配置文件。
• shell.nix：Nix Shell 配置文件。
• tsconfig.json：TypeScript 配置文件。
• tsup.config.ts：tsup 配置文件，用于打包 TypeScript 代码。

2. 项目的启动文件介绍

项目的启动主要依赖于 GitHub Action 的配置文件 action.yml。以下是 action.yml 的基本结构：

name: Magic Nix Cache Action

inputs:
  # 输入参数定义
  ...

runs-on: ubuntu-22.04  # 指定运行环境

steps:
  - name: Checkout code
    uses: actions/checkout@v4  # 使用 GitHub Action 来检出代码
  - name: Install Nix
    uses: DeterminateSystems/nix-installer-action@main  # 使用 Nix 安装器 Action
  - name: Cache Nix Builds
    uses: DeterminateSystems/magic-nix-cache-action@main  # 使用 Magic Nix Cache Action
  - name: Check Nix Builds
    uses: DeterminateSystems/flake-checker-action@main  # 使用 Nix Flake 检查器 Action
  - name: Run Nix Build
    run: nix build .  # 执行 Nix 构建命令

在这个配置文件中，我们定义了几个步骤，包括检出代码、安装 Nix、缓存 Nix 构建、检查 Nix Flake 以及执行 Nix 构建。

3. 项目的配置文件介绍

项目的配置文件主要包括 .editorconfig、.eslintrc.json、prettier.config.cjs 和 tsconfig.json。

• .editorconfig：用于配置不同编辑器的代码风格，例如缩进、换行符等。

root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

• .eslintrc.json：用于配置 ESLint 的代码质量检查规则。

{
  "extends": ["eslint:recommended"],
  "rules": {
    "indent": ["error", 2],
    "linebreak-style": ["error", "unix"],
    "quotes": ["error", "double"],
    "semi": ["error", "always"],
    "no-unused-expressions": ["error"]
  }
}

• prettier.config.cjs：用于配置 Prettier 的代码格式化规则。

module.exports = {
  trailingComma: 'es5',
  tabWidth: 2,
  semi: true,
  singleQuote: false
};

• tsconfig.json：用于配置 TypeScript 编译选项。

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true
  },
  "include": ["src/**/*"]
}

以上是 Magic Nix Cache Action 的基本使用教程，包括项目目录结构、启动文件和配置文件的介绍。通过遵循这些指南，您可以轻松地将 Magic Nix Cache Action 集成到您的 GitHub Actions 工作流中。

magic-nix-cache-action Save 30-50%+ of CI time without any effort or cost. Use Magic Nix Cache, a totally free and zero-configuration binary cache for Nix on GitHub Actions. 项目地址: https://gitcode.com/gh_mirrors/ma/magic-nix-cache-action