Skip to content

Latest commit

 

History

History
118 lines (101 loc) · 4.77 KB

looker.md

File metadata and controls

118 lines (101 loc) · 4.77 KB
Raw

Looker's branch of Calcite Avatica

This document describes how to develop Looker's branch of Calcite Avatica.

Do not merge to Avatica's main branch.

Development

Looker has poor infrastructure for testing with local builds of Avatica. The easiest way is to upload a snapshot version to Looker's Nexus repository and use it. To upload a snapshot version, simply run ./looker-snapshot.sh, which runs ./gradlew build and, if successful, uploads the resulting artifacts to the repo using the version number configured in gradle.properties (plus a "-SNAPSHOT" suffix).

Then, update the version in Looker's internal/repositories/maven_deps.bzl and repin, and you're ready to build.

To build Calcite with a snapshot build of Avatica, use ./gradlew publishToMavenLocal to publish it in your ~/.m2/ local repository, then enable the local repo in Calcite by un-commenting the line enableMavenLocal=true in Calcite's gradle.properties, and pick the version of Avatica you just built.

Release

Release will have a name like 1.21.1-looker (if the most recent official Calcite release is 1.21) and have a git tag avatica-1.21.1-looker.

You should make it from a branch that differs from Avatica's main branch in only minor ways:

  • Cherry-pick commits from the previous avatica-x.xx.x-looker release that set up Looker's repositories (or, if you prefer, rebase the previous release branch onto the latest main)
  • If necessary, include one or two commits for short-term fixes, but log JIRA cases to get them into main (use component avatica).
  • Keep fixup commits coherent (squash incremental commits) and to a minimum.
  • The final commit for a release must only set the version in gradle.properties, and it must be the only such commit that differs from Avatica trunk. Note that Avatica increments the version in trunk immediately after each release, so that version is typically unreleased. The Looker version should be named after the most recent Avatica release, so the version in trunk is generally decremented while adding the -looker suffix.

In Avatica's gradle.properties, update the value of calcite.avatica.version to the release name (something like 1.22.1-looker). Additionally, update the DRIVER_USER_AGENT property string in LookerSdkFactory to point to the same build version and commit.

Define Looker's Nexus repository in your ~/.gradle/init.gradle.kts file:

allprojects {
    plugins.withId("maven-publish") {
        configure<PublishingExtension> {
            repositories {
                maven {
                    name = "lookerNexus"
                    val baseUrl = "https://nexusrepo.looker.com"
                    val releasesUrl = "$baseUrl/repository/maven-releases"
                    val snapshotsUrl = "$baseUrl/repository/maven-snapshots"
                    val release = !project.version.toString().endsWith("-SNAPSHOT")
                    // val release = project.hasProperty("release")
                    url = uri(if (release) releasesUrl else snapshotsUrl)
                    credentials {
                        username = "xxx"
                        password = "xxx"
                    }
                }
            }
        }
    }
}

In the above fragment, replace the values of the username and password properties with the secret credentials.

NOTE This fragment must be in a file outside of your git sandbox. If the file were in the git sandbox, it would be too easy to accidentally commit the secret credentials and expose them on a public site.

Publish:

./gradlew -Prelease -PskipSign publishAllPublicationsToLookerNexusRepository

Check the artifacts on Nexus.

If the release was successful, tag the release and push the tag:

git tag avatica-1.21.1-looker HEAD
git push looker avatica-1.21.1-looker