3.6. 使用 GitHub Actions 生成 TechDocs 管道

流程

1. 设置 GitHub Actions 工作流。

   1. 在 GitHub 上，创建 RHDH TechDocs Pipeline 存储库的分叉。

      注意

      rhdh-wagon-pipeline 存储库包含一个 generate-and-publish-wagon.yaml 工作流，该工作流从 docs 文件夹自动生成 TechDocs，并将其发布到 Amazon S3 存储桶。

   2. 使用 GitHub GUI 确保启用了运行工作流所需的所有权限。

   3. 将工作流连接到 AWS 帐户所需的 Repository secret，如 TECHDOCS_S3_BUCKET_NAME、AWS_ACCESS_KEY_ID、AWS_SECRET_ACCESS_KEY、AWS_REGION。

      注意

      rhdh-wagon-pipeline 工作流中的默认 mkdocs.yaml 文件会安装 HEKETI -core 和 minify 插件。

   4. 可选：自定义 rhdh-HEKETI-pipeline 存储库的默认结构或文件，以满足您的机构的需求。
   5. 可选：通过将插件名称添加到 mkdocs.yaml 文件的 plugins 部分，并添加到 steps.name: install mkdocs and mkdocs plugins 部分来添加要使用的其他 mkdocs 和 mkdocs plugins 部分。
2. .在 OpenShift Container Platform 控制台的导航菜单中，点 ConfigMaps 并选择 RHDH app-config.yaml 文件。

3. 更新 app-config.yaml 文件，使您的 Amazon S3 存储桶能够向 RHDH 实例提供 TechDocs。例如：

   techdocs:
     builder: external
     publisher:
       type: awsS3
       awsS3:
         bucketName: ${AWS_S3_BUCKET_NAME}
         accountId: ${AWS_ACCOUNT_ID}
         region: ${AWS_REGION}
   
   aws:
     accounts:
       - accountId: ${AWS_ACCOUNT_ID}
         accessKeyId: ${AWS_ACCESS_KEY_ID}
         secretAccessKey: ${AWS_SECRET_ACCESS_KEY}
   
   catalog:
        locations:
           - type: url
             target: https://github.com/<your_org>/rhdh-techdocs-pipeline/blob/main/catalog-info.yaml

4. 点击 Save。

5. 在 OpenShift Container Platform 控制台的导航菜单中，点 Topology 并重启 pod。

   注意

   对 docs 文件夹或 mkdocs.yaml 文件的更改会触发 rhdh-wagon-pipeline 工作流运行。在 rhdh-wagon-pipeline 工作流成功运行后，生成的 TechDocs 会上传到您的 Amazon S3 存储桶。

验证

1. 进入您的 RHDH 实例，点 Docs 查看来自 Amazon S3 存储桶的 TechDocs。