File tree Expand file tree Collapse file tree 1 file changed +7
-6
lines changed Expand file tree Collapse file tree 1 file changed +7
-6
lines changed Original file line number Diff line number Diff line change @@ -5,9 +5,9 @@ This guide will help you set up docs previews for your GitHub repository.
55## GitHub Workflows
66
77The docs preview system consists of three GitHub Workflows:
8- - ` docs-build.yml ` : Build the docs on a PR
9- - ` docs-deploy.yml ` : Deploy the docs to our preview environment
10- - ` docs-cleanup.yml ` : Cleanup the docs after a PR is merged or closed
8+ - [ ` docs-build.yml ` ] ( #build ) : ** Build** the docs on a PR
9+ - [ ` docs-deploy.yml ` ] ( #deploy ) : ** Deploy** the docs to our preview environment
10+ - [ ` docs-cleanup.yml ` ] ( #cleanup ) : ** Cleanup** the docs after a PR is merged or closed
1111
1212
1313### Build
3737 pull-requests : read
3838` ` `
3939
40- 1. The naming is important, don't change it
40+ 1. The naming is important so that the ` docs-deploy` workflow is triggered.
41412. This should be the path to your docs folder.
42423. Reusable workflow : [elastic/docs-builder/.github/workflows/preview-build.yml](https://github.com/elastic/docs-builder/blob/main/.github/workflows/preview-build.yml)
4343
@@ -58,7 +58,8 @@ name: docs-deploy
5858
5959on:
6060 workflow_run:
61- workflows: [docs-build] <1>
61+ workflows:
62+ - docs-build <1>
6263 types:
6364 - completed
6465
7172 deployments: write
7273 actions: read
7374` ` `
74- 1. The name of the previous workflow.
75+ 1. The name of the previously mentioned `docs-build` workflow.
75762. Reusable workflow : [elastic/docs-builder/.github/workflows/preview-deploy.yml](https://github.com/elastic/docs-builder/blob/main/.github/workflows/preview-deploy.yml)
76773. No need to read the code.
7778
You can’t perform that action at this time.
0 commit comments