Skip to content

Latest commit

 

History

History
105 lines (88 loc) · 4.2 KB

looker.md

File metadata and controls

105 lines (88 loc) · 4.2 KB
Raw

Looker's branch of Calcite

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

Do not merge to Calcite's master branch.

Development

Read the instructions in the looker-release.sh script, but do not run that script until you're ready to publish a production release.

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 snapshot artifacts to the repo using the version number configured in gradle.properties (plus a "-SNAPSHOT" suffix).

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

Release

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.

Read the instructions in the looker-release.sh script, then run it. The script will only make local changes. You'll have a chance to review them before pushing anything to Nexus or GitHub.

Each 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 calcite-1.21.1-looker.

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

  • Cherry-pick commits from the previous calcite-x.xx.x-looker release that set up Looker's repositories (or, if you prefer, rebase the previous release branch onto the latest master)
  • If necessary, include one or two commits for short-term fixes, but log JIRA cases to get them into master.
  • 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 Calcite trunk. Note that Calcite 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 Calcite release, so the version in trunk is generally decremented while adding the -looker suffix.

Check the artifacts on Nexus.