Skip to content

Extract doctest from main CI workflow #915

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

Closed
Yury-Fridlyand wants to merge 2 commits into from
Closed

Extract doctest from main CI workflow #915

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c470e7d
Try to deactivate doctest in gradle workflow.
Yury-Fridlyand Oct 13, 2022
0a8b18d
Add new CI workflow.
Yury-Fridlyand Oct 13, 2022
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
27 changes: 27 additions & 0 deletions .github/workflows/sql-doctest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: SQL Doctest CI

on:
pull_request:
push:
branches-ignore:
- 'dependabot/**'
paths:
- '**/*.java'
- '**/*.g4'
- '!sql-jdbc/**'
- '**gradle*'
- '**/*.jar'
- '**/*.pom'
- 'doctest/**'
- 'docs/**'
- '.github/workflows/sql-doctest.yml'

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3

- name: Build with Gradle
run: ./gradlew :doctest:doctest
4 changes: 3 additions & 1 deletion doctest/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@ task stopOpenSearch(type: KillProcessTask)
doctest.dependsOn startOpenSearch
doctest.finalizedBy stopOpenSearch

build.dependsOn doctest
// Deactivate doctest in the main gradle workflow (./gradlew build), because doctest depends
// on ML plugin and it ruins SQL plugin build if ML plugin is not available (not released)
// build.dependsOn doctest
Copy link
Member

@joshuali925 joshuali925 Oct 19, 2022

Choose a reason for hiding this comment

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

if it's for CI only, maybe disable in workflow instead of removing doctest from build task?

But could you explain more on why? If ml-commons is missing and doctest cannot run, we should not merge in PR anyways since we don't know if the PR breaks other doctests

Copy link
Collaborator Author

@Yury-Fridlyand Yury-Fridlyand Oct 19, 2022

Choose a reason for hiding this comment

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

we should not merge in PR anyways

I agree. Unfortunately, gradle runs doctests before integration tests and before most of the unit tests. This results in a PR with failed SQL Java CI workflow, which crashed on doctests.
The proposed change unblocks UT and IT from doctest. The PR will remain blocked by a failing CI workflow - SQL Doctest CI. We will be able to identify that all tests really pass and we are waiting for ML release to complete the PR.

clean.dependsOn(cleanBootstrap)

// 2.0.0-alpha1-SNAPSHOT -> 2.0.0.0-alpha1-SNAPSHOT
Expand Down