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

feat(all): only build docs if there's a doc change #3067

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

kruskall
Copy link
Member

extend the check to all remaining repositories

extend the check to all remaining repositories
Copy link

A documentation preview will be available soon.

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.

Comment on lines +145 to +148
"kibana")
git fetch origin "$GITHUB_PR_TARGET_BRANCH"
docs_diff=$(git diff --stat "origin/$GITHUB_PR_TARGET_BRANCH"...HEAD -- ./docs ":(glob)x-pack/**/*.asciidoc" ":(glob)src/**/*.asciidoc" ":(glob)examples/**/*.asciidoc")
;;
Copy link
Member

Choose a reason for hiding this comment

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

@lcawl I might need your expertise on the link checking service to make sure we include the right file(s) here

Copy link
Member Author

Choose a reason for hiding this comment

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

fwiw the files are from:

Copy link
Member

Choose a reason for hiding this comment

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

That's correct for every other repo. The Kibana repo, however, has a unique job that is defined outside of conf.yaml—link checking doc links from within the product.

Here's the function:

sub check_kibana_links {

There's a chance that it's as easy as adding these two files:

my $src_path = 'src/ui/public/documentation_links/documentation_links';

my $legacy_path = 'src/legacy/ui/public/documentation_links/documentation_links';

@bmorelli25
Copy link
Member

This is incredible

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.

2 participants