Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add GH action for posting docs preview #2389

Merged
merged 1 commit into from
Nov 30, 2023
Merged

Add GH action for posting docs preview #2389

merged 1 commit into from
Nov 30, 2023

Conversation

nkammah
Copy link
Contributor

@nkammah nkammah commented Nov 29, 2023

Should be merged after https://github.com/elastic/docs/pull/2843/files and it looks as below (when docs PR are opened):

image

Copy link
Member

@pquentin pquentin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! LGTM.

@nkammah nkammah merged commit c91b8fe into main Nov 30, 2023
19 checks passed
@nkammah nkammah deleted the docs-gh-action branch November 30, 2023 08:14
@pquentin
Copy link
Member

pquentin commented Nov 30, 2023

@nkammah Thanks! What is the command to trigger Buildkite builds for community contributions?

For Buildkite integration tests I've configured the pr-bot in https://github.com/elastic/elasticsearch-py/blob/8.11/.buildkite/pull-requests.json as documented in https://docs.elastic.dev/ci/configuring-pull-requests-for-buildkite, but commenting buildkite test this please did not trigger any Buildkite docs in #2252 (It does trigger a Jenkins build however: https://elasticsearch-ci.elastic.co/job/elastic+elasticsearch-py+pull-request+build-docs/948/)

@nkammah
Copy link
Contributor Author

nkammah commented Nov 30, 2023

Ha good point @pquentin - I forgot to document it; the below commands are supported:

run docs-build
run docs-build rebuild
run docs-build warnlinkcheck
run docs-build skiplinkcheck (takes precedence over the warnlinkcheck option)

@pquentin
Copy link
Member

Thanks! I'll try that next.

(It would be nice if buildkite test this please or an equivalent universal command could build the docs too, as is done today, which would avoid learning new commands.)

@nkammah
Copy link
Contributor Author

nkammah commented Nov 30, 2023

Ha - that can be arranged, by maybe leveraging the always_trigger_comment_regex option of the bot and support some parameters. Could you kindly open an issue here?

@pquentin
Copy link
Member

pquentin commented Dec 1, 2023

Looks like this is now supported, thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants