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

Auto-generate preview links for DOC PRs #139593

Merged
merged 5 commits into from
Sep 1, 2022
Merged

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Aug 26, 2022

Summary

Adds a GitHub Action that will automatically create preview links when a doc pull request is created. Links are added in a comment on the PR.

Borrowed from @richkuz and elastic/elasticsearch#89670 -- Thanks!

@lcawl lcawl added Team:Docs docs v8.5.0 v8.4.2 release_note:skip Skip the PR/issue when compiling release notes labels Aug 26, 2022
@lcawl lcawl force-pushed the doc-preview-links branch from 1d672db to f36fe09 Compare August 26, 2022 20:34
@lcawl lcawl marked this pull request as ready for review August 26, 2022 20:47
@lcawl lcawl requested a review from a team as a code owner August 26, 2022 20:47
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

@spalger
Copy link
Contributor

spalger commented Aug 30, 2022

Would you mind including an irrelevant change to some asciidoc file in this PR so we can see the github action execute?

@lcawl
Copy link
Contributor Author

lcawl commented Aug 31, 2022

I added some minor fixes to an asciidoc file, however I think it won't trigger the workflow since it runs only when the pull request is opened per https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target. You can see an example of its behaviour in the elasticsearch repo here: elastic/elasticsearch#89756 (comment)

@lcawl lcawl merged commit 5ea3838 into elastic:main Sep 1, 2022
@lcawl lcawl deleted the doc-preview-links branch September 1, 2022 15:02
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Sep 1, 2022
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.4

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Sep 1, 2022
(cherry picked from commit 5ea3838)

Co-authored-by: Lisa Cawley <[email protected]>
Mpdreamz pushed a commit to Mpdreamz/kibana that referenced this pull request Sep 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs release_note:skip Skip the PR/issue when compiling release notes Team:Docs v8.4.2 v8.5.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants