From bff88a372482c62fe6372c1c2efcdfb4a899561f Mon Sep 17 00:00:00 2001 From: nassimkammah Date: Wed, 13 Dec 2023 15:48:37 +0100 Subject: [PATCH] update action text --- .github/actions/docs-preview/action.yml | 42 ++++++++++++------------- 1 file changed, 20 insertions(+), 22 deletions(-) diff --git a/.github/actions/docs-preview/action.yml b/.github/actions/docs-preview/action.yml index cd6b840d12125..35a614651a6d4 100644 --- a/.github/actions/docs-preview/action.yml +++ b/.github/actions/docs-preview/action.yml @@ -27,29 +27,27 @@ runs: script: | const { REPO, PR, PREVIEW_PATH } = process.env - const comment = `A documentation preview will be available soon. - Help us out by validating the Buildkite preview and reporting issues [here](https://github.com/elastic/docs/issues/new?labels=buildkite-migration,bug). Please also be sure to **double check all images to ensure they are correct** in the preview. - - - ๐Ÿ”จ Buildkite [builds](https://buildkite.com/elastic/docs-build-pr/builds?meta_data[repo_pr]=${REPO}_${PR}) - - ๐Ÿ“š HTML diff: [Buildkite](https://${REPO}_bk_${PR}.docs-preview.app.elstc.co/diff) - [Jenkins](https://${REPO}_${PR}.docs-preview.app.elstc.co/diff) - - ๐Ÿ“™ Preview: [Buildkite](https://${REPO}_bk_${PR}.docs-preview.app.elstc.co/${PREVIEW_PATH}) - [Jenkins](https://${REPO}_${PR}.docs-preview.app.elstc.co/${PREVIEW_PATH}) - - ๐Ÿงช [Buildkite vs Jenkins diff](https://github.com/elastic/built-docs/compare/${REPO}_bk_${PR}..${REPO}_${PR}) - -
- Requesting new docs builds via comments - - \`\`\` - run docs-build - run docs-build rebuild - run docs-build warnlinkcheck - run docs-build skiplinkcheck (takes precedence over the warnlinkcheck option) - buildkite test this - buildkite test this rebuild - buildkite test this warnlinkcheck - buildkite test this skiplinkcheck - \`\`\` + const comment = `A documentation preview will be available soon.
+ Help us out by validating the Buildkite preview and reporting issues [here](https://github.com/elastic/docs/issues/new?labels=buildkite-migration,bug). + Please also be sure to **double check all images to ensure they are correct** in the preview. + + - ๐Ÿ”จ Buildkite [builds](https://buildkite.com/elastic/docs-build-pr/builds?meta_data[repo_pr]=${REPO}_${PR}) + - ๐Ÿ“š HTML diff: [Buildkite](https://${REPO}_bk_${PR}.docs-preview.app.elstc.co/diff) - [Jenkins](https://${REPO}_${PR}.docs-preview.app.elstc.co/diff) + - ๐Ÿ“™ Preview: [Buildkite](https://${REPO}_bk_${PR}.docs-preview.app.elstc.co/${PREVIEW_PATH}) - [Jenkins](https://${REPO}_${PR}.docs-preview.app.elstc.co/${PREVIEW_PATH}) + - ๐Ÿงช [Buildkite vs Jenkins diff](https://github.com/elastic/built-docs/compare/${REPO}_bk_${PR}..${REPO}_${PR}) + + +
+ Request a new doc build by commenting + + * Rebuild this PR: \`run docs-build\` + * Rebuild this PR and all Elastic docs: \`run docs-build rebuild\` + + `run docs-build` is much faster than `run docs-build rebuild`. A `rebuild` should only be needed in rare situations. + + If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status [here](https://buildkite.com/elastic/docs-build).
- `; + `; github.rest.issues.createComment({ issue_number: PR,