Skip to content

Adds more variables to Kibana link checker #2132

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.

Sign up for GitHub

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

Merged
lcawl merged 4 commits into from
Jun 8, 2021
Merged

Adds more variables to Kibana link checker #2132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2b876ce
Adds more variables to Kibana link checker
lcawl Jun 7, 2021
756e73c
Update build_docs.pl
lcawl Jun 7, 2021
a43b868
Update build_docs.pl
lcawl Jun 7, 2021
8518505
Add integration tests for new variables
gtback Jun 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion build_docs.pl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,18 +352,23 @@ sub check_kibana_links {
# ${baseUrl}guide/en/elasticsearch/reference/${urlVersion}/modules-scripting-expression.html
# ${ELASTIC_WEBSITE_URL}guide/en/beats/filebeat/${DOC_LINK_VERSION}
# ${ELASTIC_DOCS}search-aggregations-bucket-datehistogram-aggregation.html
# ${ELASTICSEARCH_DOCS}update-transform.html
# ${KIBANA_DOCS}canvas.html
# ${PLUGIN_DOCS}repository-s3.html

my $extractor = sub {
my $contents = shift;
return sub {
while ( $contents =~ m!`(\$\{(?:baseUrl|ELASTIC.+)\}[^`]+)`!g ) {
while ( $contents =~ m!`(\$\{(?:baseUrl|ELASTIC.+|KIBANA_DOCS|PLUGIN_DOCS)\}[^`]+)`!g ) {
my $path = $1;
$path =~ s/\$\{(?:DOC_LINK_VERSION|urlVersion)\}/$branch/;
# In older versions, the variable `${ELASTIC_DOCS}` referred to
# the Elasticsearch Guide. In newer branches, the
# variable is called `${ELASTICSEARCH_DOCS}`
$path =~ s!\$\{ELASTIC_DOCS\}!en/elasticsearch/reference/$branch/!;
$path =~ s!\$\{ELASTICSEARCH_DOCS\}!en/elasticsearch/reference/$branch/!;
$path =~ s!\$\{KIBANA_DOCS\}!en/kibana/$branch/!;
$path =~ s!\$\{PLUGIN_DOCS\}!en/elasticsearch/plugins/$branch/!;
# Replace the "https://www.elastic.co/guide/" URL prefix so that
# it becomes a file path in the built docs.
$path =~ s!\$\{(?:baseUrl|ELASTIC_WEBSITE_URL)\}guide/!!;
Expand Down
16 changes: 14 additions & 2 deletions integtest/spec/all_books_broken_link_detection_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,9 +134,21 @@
end
describe 'when there is a broken Elasticsearch Guide link in Kibana' do
include_context 'there is a kibana link', true,
'${ELASTICSEARCH_DOCS}missing-page', true
'${ELASTICSEARCH_DOCS}missing-page.html', true
include_examples 'there are broken links in kibana',
'en/elasticsearch/reference/master/missing-page'
'en/elasticsearch/reference/master/missing-page.html'
end
describe 'when there is a broken Kibana guide link' do
include_context 'there is a kibana link', true,
'${KIBANA_DOCS}not-a-kibana-page.html', true
include_examples 'there are broken links in kibana',
'en/kibana/master/not-a-kibana-page.html'
end
describe 'when there is a broken ES Plugin link' do
include_context 'there is a kibana link', true,
'${PLUGIN_DOCS}not-a-valid-plugin.html', true
include_examples 'there are broken links in kibana',
'en/elasticsearch/plugins/master/not-a-valid-plugin.html'
end
describe 'when using --keep_hash and --sub_dir together like a PR test' do
describe 'when there is a broken link in one of the books being built' do
Expand Down