Haskell 公司列表项目教程

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

haskell-companies/
├── README.md
├── companies.json
└── .github
    └── workflows
        └── ci.yml

• README.md: 项目的主文档，包含项目的介绍、使用方法和贡献指南。
• companies.json: 存储公司信息的主要文件，包含公司的名称、网站、使用的 Haskell 技术等。
• .github/workflows/ci.yml: GitHub Actions 的工作流配置文件，用于自动化测试和部署。

2. 项目的启动文件介绍

项目没有传统的“启动文件”，因为这是一个静态列表项目，主要内容存储在 companies.json 文件中。用户可以通过读取该文件来获取公司信息。

3. 项目的配置文件介绍

项目的配置主要通过 .github/workflows/ci.yml 文件进行管理。该文件定义了 GitHub Actions 的工作流程，包括代码的自动化测试和部署。

name: CI

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2
    - name: Validate JSON
      run: |
        npm install -g ajv-cli
        ajv validate -s companies.schema.json -d companies.json

• name: 工作流的名称。
• on: 触发工作流的事件，包括 push 和 pull request。
• jobs: 定义工作流的任务。
• runs-on: 指定运行任务的虚拟机环境。
• steps: 定义具体的执行步骤，包括代码检出和 JSON 文件验证。

以上是 Haskell 公司列表项目的简要教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。