如何配置GitLab CI/CD来生成并保存文档作为工件?
时间: 2024-09-12 11:15:23 浏览: 56
配置GitLab CI/CD来生成并保存文档作为工件,通常需要以下几个步骤:
1. **创建CI/CD配置文件**:在项目的根目录下创建或编辑`.gitlab-ci.yml`文件,这是GitLab CI/CD的配置文件。
2. **定义作业阶段**:在配置文件中定义作业,并将作业放在合适的阶段(如`build`或`test`)。
3. **编写构建脚本**:在作业中指定运行的脚本(`script`)来生成文档。例如,如果你使用Sphinx来生成Python文档,你可以运行`sphinx-build -b html source/ build/html`。
4. **保存工件**:在作业的脚本执行完毕后,使用`artifacts`指令指定要保存为工件的文件或目录。例如,如果你想要保存生成的文档,可以添加`artifacts: paths: - build/html`。
5. **运行和测试**:推送代码到GitLab仓库,触发CI/CD流程。在GitLab CI/CD的作业日志中检查是否成功生成并保存了文档作为工件。
下面是一个简单的`.gitlab-ci.yml`配置示例:
```yaml
stages:
- build
- test
build_job:
stage: build
script:
- pip install sphinx
- sphinx-build -b html source/ build/html
artifacts:
paths:
- build/html
expire_in: 1 week
```
这个配置定义了两个阶段:`build`和`test`。`build_job`作业在`build`阶段运行,安装必要的软件包,生成HTML格式的Sphinx文档,并将`build/html`目录保存为工件。工件将在一周后过期,除非你手动删除。
阅读全文