-
Notifications
You must be signed in to change notification settings - Fork 25k
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
Docs: Skip xpack snippet tests if no xpack #31619
Docs: Skip xpack snippet tests if no xpack #31619
Conversation
Skips tests the require xpack if we run the doc build without xpack. So this should work: ``` ./gradlew -p docs check -Dtests.distribution=oss-zip ``` This is implemented by detecting parts of the doc that look like: ``` [testenv="basic"] ``` Relates to elastic#30665
Pinging @elastic/es-core-infra |
@@ -63,6 +63,8 @@ buildRestTests.docs = fileTree(projectDir) { | |||
exclude 'README.asciidoc' | |||
} | |||
|
|||
listSnippets.docs = buildRestTests.docs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a "bonus" fix that I made while so that listSnippets
wouldn't fail. I use listSnippets
to help make the changes above.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice! lgtm!
Skips tests the require xpack if we run the doc build without xpack. So this should work: ``` ./gradlew -p docs check -Dtests.distribution=oss-zip ``` This is implemented by detecting parts of the doc that look like: ``` [testenv="basic"] ``` Relates to #30665
Thanks for reviewing @hub-cap! |
* master: Docs: Remove duplicate test setup Print output when the name checker IT fails (#31660) Fix syntax errors in get-snapshots docs (#31656) Docs: Fix description of percentile ranks example example (#31652) Add MultiSearchTemplate support to High Level Rest client (#30836) Add test for low-level client round-robin behaviour (#31616) SQL: Refactor package names of sql-proto and sql-shared-proto projects (#31622) Remove deprecation warnings to prepare for Gradle 5 (sourceSets.main.output.classesDirs) (#30389) Correct integTest enable logic (#31646) Fix missing get-snapshots docs reference #31645 Do not check for Azure container existence (#31617) Merge AwsS3Service and InternalAwsS3Service in a S3Service class (#31580) Upgrade gradle wrapper to 4.8 (#31525) Only set vm.max_map_count if greater than default (#31512) Add Get Snapshots High Level REST API (#31537) QA: Merge query-builder-bwc to restart test (#30979) Update reindex.asciidoc (#31626) Docs: Skip xpack snippet tests if no xpack (#31619) mute CreateSnapshotRequestTests HLRest: Fix test for explain API [TEST] Fix RemoteClusterConnectionTests Add Create Snapshot to High-Level Rest Client (#31215) Remove legacy MetaDataStateFormat (#31603) Add explain API to high-level REST client (#31387) Preserve thread context when connecting to remote cluster (#31574) Unify headers for full text queries Remove redundant 'minimum_should_match' JDBC driver prepared statement set* methods (#31494) [TEST] call yaml client close method from test suite (#31591)
* 6.x: Docs: Remove duplicate test setup Docs: Fix description of percentile ranks example example (#31652) Remove deprecation warnings to prepare for Gradle 5 (sourceSets.main.output.classesDirs) (#30389) Do not check for Azure container existence (#31617) Merge AwsS3Service and InternalAwsS3Service in a S3Service class (#31580) Remove item listed in 6.3 notes that's not in 6.3 (#31623) remove unused import Upgrade gradle wrapper to 4.8 (#31525) Only set vm.max_map_count if greater than default (#31512) QA: Merge query-builder-bwc to restart test (#30979) Docs: Skip xpack snippet tests if no xpack (#31619) [TEST] Fix RemoteClusterConnectionTests Remove legacy MetaDataStateFormat (#31603) [TEST] call yaml client close method from test suite (#31591) [TEST] Close additional clients created while running yaml tests (#31575) Node selector per client rather than per request (#31471) Preserve thread context when connecting to remote cluster (#31574) Remove redundant 'minimum_should_match' Unify headers for full text queries JDBC driver prepared statement set* methods (#31494) add logging breaking changes from 5.3 to 6.0 (#31583) Fix a formatting issue in the docvalue_fields documentation. (#31563) Improve robustness of geo shape parser for malformed shapes QA: Create xpack yaml features (#31403)
…80459) Removes `testenv` annotations and related code. These annotations originally let you skip x-pack snippet tests in the docs. However, that's no longer possible. Relates to #79309, #31619 # Conflicts: # docs/reference/ingest/range-enrich-policy-type-ex.asciidoc # docs/reference/migration/apis/feature_upgrade.asciidoc # docs/reference/ml/df-analytics/apis/get-trained-model-deployment-stats.asciidoc # docs/reference/ml/df-analytics/apis/infer-trained-model-deployment.asciidoc # docs/reference/ml/df-analytics/apis/put-trained-model-definition-part.asciidoc # docs/reference/ml/df-analytics/apis/put-trained-model-vocabulary.asciidoc # docs/reference/ml/df-analytics/apis/start-trained-model-deployment.asciidoc # docs/reference/ml/df-analytics/apis/stop-trained-model-deployment.asciidoc # docs/reference/slm/apis/slm-delete.asciidoc # docs/reference/slm/apis/slm-execute-retention.asciidoc # docs/reference/slm/apis/slm-execute.asciidoc # docs/reference/slm/apis/slm-get-status.asciidoc # docs/reference/slm/apis/slm-get.asciidoc # docs/reference/slm/apis/slm-start.asciidoc # docs/reference/slm/apis/slm-stats.asciidoc # docs/reference/slm/apis/slm-stop.asciidoc # docs/reference/sql/endpoints/client-apps/tableau-desktop.asciidoc # docs/reference/sql/endpoints/client-apps/tableau-server.asciidoc # docs/reference/transform/apis/upgrade-transforms.asciidoc
…80458) Removes `testenv` annotations and related code. These annotations originally let you skip x-pack snippet tests in the docs. However, that's no longer possible. Relates to #79309, #31619 # Conflicts: # docs/reference/ml/df-analytics/apis/get-trained-model-deployment-stats.asciidoc # docs/reference/ml/df-analytics/apis/infer-trained-model-deployment.asciidoc # docs/reference/ml/df-analytics/apis/put-trained-model-definition-part.asciidoc # docs/reference/ml/df-analytics/apis/put-trained-model-vocabulary.asciidoc # docs/reference/ml/df-analytics/apis/start-trained-model-deployment.asciidoc # docs/reference/ml/df-analytics/apis/stop-trained-model-deployment.asciidoc # docs/reference/slm/apis/slm-delete.asciidoc # docs/reference/slm/apis/slm-execute-retention.asciidoc # docs/reference/slm/apis/slm-execute.asciidoc # docs/reference/slm/apis/slm-get-status.asciidoc # docs/reference/slm/apis/slm-get.asciidoc # docs/reference/slm/apis/slm-start.asciidoc # docs/reference/slm/apis/slm-stats.asciidoc # docs/reference/slm/apis/slm-stop.asciidoc # docs/reference/sql/endpoints/client-apps/tableau-desktop.asciidoc # docs/reference/sql/endpoints/client-apps/tableau-server.asciidoc
Skips tests the require xpack if we run the doc build without xpack. So
this should work:
This is implemented by detecting parts of the doc that look like:
Relates to #30665