Merge for 2.27.0-rc0 release (#608)

## Usage and product changes

We merge development into master for 2.27.0-rc0 release.

Author: typedb-bot

.circleci/config.yml

@@ -76,9 +76,9 @@ commands:
         type: string
     steps:
       - run: |
-          apt-get -y update
-          DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends tzdata
-          apt-get -y install curl build-essential git python3 python3-pip default-jre lsof cmake file wget
+          apt update -y
+          DEBIAN_FRONTEND=noninteractive apt install -y --no-install-recommends tzdata
+          apt install -y curl build-essential git python3 python3-pip default-jre lsof cmake file wget
           curl -OL "https://github.com/bazelbuild/bazelisk/releases/download/v1.17.0/bazelisk-linux-<<parameters.bazel-arch>>"
           mv "bazelisk-linux-<<parameters.bazel-arch>>" /usr/local/bin/bazel
           chmod a+x /usr/local/bin/bazel
@@ -685,9 +685,9 @@ jobs:
       - install-bazel-apt:
           bazel-arch: amd64
       - run: |
-          apt update && apt install software-properties-common
+          apt update -y && apt install -y software-properties-common
           add-apt-repository ppa:deadsnakes/ppa
-          apt update && apt install -y python3.9 python3.9-distutils python3-pip software-properties-common
+          apt update -y && apt install -y python3.9 python3.9-distutils python3-pip software-properties-common
           python3.9 -m pip install -U cffi
           export SYNC_DEPENDENCIES_TOKEN=$REPO_GITHUB_TOKEN
           bazel run @vaticle_dependencies//tool/sync:dependencies -- --source ${CIRCLE_PROJECT_REPONAME}@$(cat VERSION)
@@ -708,28 +708,28 @@ workflows:
       - deploy-snapshot-linux-arm64:
           filters:
             branches:
-              only: [master]
+              only: [development, master]
       - deploy-snapshot-linux-x86_64:
           filters:
             branches:
-              only: [master]
+              only: [development, master]
       - deploy-snapshot-mac-arm64:
           filters:
             branches:
-              only: [master]
+              only: [development, master]
       - deploy-snapshot-mac-x86_64:
           filters:
             branches:
-              only: [master]
+              only: [development, master]
       - deploy-snapshot-windows-x86_64:
           filters:
             branches:
-              only: [master]
+              only: [development, master]
 
       - deploy-snapshot-any:
           filters:
             branches:
-              only: [master]
+              only: [development, master]
           requires:
             - deploy-snapshot-linux-arm64
             - deploy-snapshot-linux-x86_64

.factory/automation.yml

@@ -73,7 +73,7 @@ build:
         curl -L https://github.com/doxygen/doxygen/releases/download/Release_1_10_0/doxygen-1.10.0.linux.bin.tar.gz | tar xzO doxygen-1.10.0/bin/doxygen > /var/tmp/doxygen &&
           sudo mv /var/tmp/doxygen /usr/local/bin/ && sudo chmod +x /usr/local/bin/doxygen
         bazel run @vaticle_dependencies//tool/bazelinstall:remote_cache_setup.sh
-        DOCS_DIRS="java/docs nodejs/docs python/docs rust/docs cpp/docs"
+        DOCS_DIRS="java/docs nodejs/docs python/docs rust/docs cpp/docs c/docs"
         rm -rf $DOCS_DIRS
         tool/docs/update.sh
         git add $DOCS_DIRS

RELEASE_NOTES_LATEST.md

@@ -9,7 +9,7 @@ Documentation: https://typedb.com/docs/drivers/rust/overview
 
 
 ```sh
-cargo add typedb-driver@2.26.6
+cargo add typedb-driver@2.27.0-rc0
 ```
 
 
@@ -29,7 +29,7 @@ Documentation: https://typedb.com/docs/drivers/java/overview
     <dependency>
         <groupid>com.vaticle.typedb</groupid>
         <artifactid>typedb-driver</artifactid>
-        <version>2.26.6</version>
+        <version>2.27.0-rc0</version>
     </dependency>
 </dependencies>
 ```
@@ -42,7 +42,7 @@ Documentation: https://typedb.com/docs/drivers/python/overview
 Available through https://pypi.org
 
 ```
-pip install typedb-driver==2.26.6
+pip install typedb-driver==2.27.0rc0
 ```
 
 ### NodeJS driver
@@ -51,128 +51,33 @@ NPM package: https://www.npmjs.com/package/typedb-driver
 Documentation: https://typedb.com/docs/drivers/nodejs/overview
 
 ```
-npm install typedb-driver@2.26.6
+npm install typedb-driver@2.27.0-rc0
 ```
 
 ### C++ driver
 
-Compiled distributions comprising headers and shared libraries available at: https://cloudsmith.io/~typedb/repos/public-release/packages/?q=name:^typedb-driver-cpp+version:2.26.6
+Compiled distributions comprising headers and shared libraries available at: https://cloudsmith.io/~typedb/repos/public-release/packages/?q=name:^typedb-driver-cpp+version:2.27.0-rc0
 
 ### C driver
 
-Compiled distributions comprising headers and shared libraries available at: https://cloudsmith.io/~typedb/repos/public-release/packages/?q=name:^typedb-driver-clib+version:2.26.6
+Compiled distributions comprising headers and shared libraries available at: https://cloudsmith.io/~typedb/repos/public-release/packages/?q=name:^typedb-driver-clib+version:2.27.0-rc0
 Documentation: https://typedb.com/docs/drivers/cpp/overview
 
 
 ## New Features
-- **Update to allow Unicode TypeQL variable names**
-  
-  We update TypeQL and tests to ensure that support for Unicode TypeQL variable names (https://github.com/vaticle/typeql/pull/310) is included.
-  
-  
-
-## Bugs Fixed
-- **Fix Factory CI job names**
-  
-  We fix prerequisites of the sync-dependencies job and bring the C++ behaviour test job names in concordance with the rest.
-  
-- **Fix native calls in python driver rules api**
-  Fixes a bug which caused the delete, is_deleted and set_label methods on a Rule to fail.
-  
-  
-
-## Code Refactors
-- **Consolidate Factory CI behaviour test jobs per driver language**
-  
-  We merge individual `test-{lang}-behaviour-{domain}` jobs in FactoryCI into a single `test-{lang}-behaviour` job in order to reduce CI bootup and shutdown overhead per test.
-  
-  We also fix mac-x86_64 Python and maven deployment tests by explicitly enforcing the use of Rosetta.
-  
-  
-- **Transition from standalone typedb-common to typeql/common**
-  
-  We update Bazel dependencies and target paths following the merging of typedb-common into [vaticle/typeql](https://github.com/vaticle/typeql/) (see https://github.com/vaticle/typeql/pull/313).
-  
-- **Refactor C++ docs to reflect other docs**
-  Refactors generated C++ documentation so the Iterator and Future classes are documented in the answer folder.
-  
-  
-- **Move deployment jobs from Factory CI to CIrcleCI**
-  
-  We move all snapshot deployment jobs from Factory CI to CIrcleCI to ensure that assembly and deployment succeed in the same environment release deployment is performed in. We also consolidate platform independent jobs into `deploy-release/snapshot-any` to further reduce the amount of CI jobs.
-  
-- **Update driver Java tests to retrieve TypeDB runners as maven library**
-  
-  We update Java tests to use the typedb-runner and typedb-cloud-runner libraries, which are now available from Maven instead of via the Git dependency on typedb-common.
-  
-  
-
-## Other Improvements
-- **Add README to Node.js NPM package distribution**
-
-- **Fix CircleCI sync-dependencies apt installation steps**
 
-- **Only run CircleCI snapshot builds and tests in master**
 
-- **Switch to ghr v0.16.2 (support release w/o artifacts)**
-
-- **Fix maven snapshot deployment test pom version**
-
-- **Update unpropagated dependencies**
-
-- **Only deploy releases to cloudsmith**
-  
-  We implement the following changes to the release process:
-  
-  - stop uploading build artifacts to the github releases page;
-  - update the release notes documentation links;
-  - add C and C++ artifact download link templates to the release notes template.
-  
-- **Fix Factory merge artifact**
-  
-  We remove stray line in automation.yml that appeared due to an ill-resolved merge.
-  
-- **Fix CircleCI sync dependencies configuration mismatch**
-  
-  The sync-dependencies step in CircleCI used an obsolete setup step which no longer exists. This PR fixes that issue.
-  
-- **Sync dependencies in CI**
-  
-  We add a sync-dependencies job to be run in CI after successful snapshot and release deployments. The job sends a request to vaticle-bot to update all downstream dependencies.
-  
-  The snapshot dependencies sync job is run in Factory CI after all behaviour and integration tests pass. The CircleCI tests only verify deployment, which is not extensive enough verification to trigger downstream propagation, and not strictly necessary for sync as that is only affected by git dependencies.
-  
-  The release dependencies sync job, in contrast, runs in CircleCI and only runs after all deployments have succeeded and been verified, so that all downstream deployments can be safely updated.
-  
-  Importantly, due to the way sync-dependencies is implemented, we revert `dependencies/vaticle/repositories.bzl` from having a dedicated typedb-protocol version line for the purposes of workspace-status, back to inlined version with the sync-marker. This means that the sync-marker is performing double duty as a workspace status marker.
-  
-  Note: this PR does _not_ update the `dependencies` repo dependency. It will be updated automatically by the bot during its first pass.
-  
-- **Remove use of 'sudo' in CI**
+## Bugs Fixed
 
-- **Refactor npm installation and job limitation to prevent CircleCI OOM**
 
-- **Fix npm installation and Java bootup configurations**
+## Code Refactors
 
-- **Disable diagnostics reporting in CI**
 
-- **Increase CircleCI executor size for OOM**
+## Other Improvements
+- **Enable deploy-snapshot jobs on development**
 
-- **Fix NPM deploy jobs**
+- **Add -y to apt udpate, and replaced apt-get with apt**
 
-- **Migrate artifact hosting to cloudsmith**
-  
-  Updates artifact deployment & consumption rules to use cloudsmith (repo.typedb.com) instead of the self-hosted sonatype repository (repo.vaticle.com).
+- **Documentation for C driver**
+  Adds documentation for the C driver.
 
-  
-- **Move doc generation tools to bazel distribution repository**
-  Moves bazel rules used for generating documentation into the vaticle/bazel-distribution repository
-  
-  
-- **Move dependencies/maven/artifacts.bzl:vaticle_artifacts to dependencies/vaticle/artifacts.bzl:maven_artifacts**
-
-- **Move remotejdk bazelrc option into build/run/test to avoid affecting bazel queries**
-
-- **Apply release pipeline fixes**
-
-    

VERSION

@@ -1 +1 @@
-2.26.6
+2.27.0-rc0

c/BUILD

@@ -26,12 +26,15 @@ load("@vaticle_dependencies//builder/rust:rules.bzl", "rust_cbindgen")
 load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
 
 load("@vaticle_bazel_distribution//common:rules.bzl", "assemble_targz", "assemble_zip", "checksum", "assemble_versioned")
+load("@vaticle_bazel_distribution//docs:cpp/rules.bzl", "doxygen_docs")
 load("@vaticle_bazel_distribution//artifact:rules.bzl", "deploy_artifact")
 load("@vaticle_dependencies//distribution:deployment.bzl", "deployment")
 load("@rules_pkg//:pkg.bzl", "pkg_tar")
 load("@rules_pkg//pkg:mappings.bzl", "pkg_files", "strip_prefix")
 load("@vaticle_bazel_distribution//platform:constraints.bzl", "constraint_linux_arm64", "constraint_linux_x86_64",
      "constraint_mac_arm64", "constraint_mac_x86_64", "constraint_win_x86_64")
+load("//c:docs_structure.bzl", "dir_mapping", "force_file")
+load("//tool/docs:c/rules.bzl", "doxygen_c_to_adoc")
 
 clib_srcs = glob(["src/**/*.rs"])
 
@@ -217,6 +220,30 @@ alias(
     })
 )
 
+filegroup(
+    name = "_typedb_driver_h_only",
+    srcs = [":typedb_driver_clib_headers"],
+    output_group = "header"
+)
+
+doxygen_docs(
+    name = "docs_html",
+    project_name = "TypeDB C Driver",
+    sources = [":_typedb_driver_h_only"],
+    main_page_md = ":README.md",
+    tags = ["manual"],
+
+)
+
+doxygen_c_to_adoc(
+    name = "docs_adoc",
+    data = [":docs_html"],
+    docs_dirs = dir_mapping,
+    force_file = force_file,
+    output_dir = "c/docs",
+    tags = ["manual"]
+)
+
 checkstyle_test(
     name = "checkstyle",
     size = "small",
@@ -225,7 +252,7 @@ checkstyle_test(
         "src/**/*",
         "swig/*",
     ]),
-    exclude = [".clang-format", "README.md"],
+    exclude = [".clang-format", "README.md"] + glob(["docs/**/*.adoc"]),
     license_type = "apache-header",
 )
 

c/README.md

@@ -47,7 +47,7 @@ Types which have `*_close` methods will be freed on close.
 ```c
     ...
     string_free(gotName);
-    database_drop(database); // Not to be confused with database_delete.
+    database_close(database);
     database_manager_drop(databaseManager);
     connection_close(connection);
 ```

c/cbindgen.toml

@@ -22,6 +22,31 @@
 language = "C"
 
 autogen_warning = "/* Warning, this file is autogenerated by cbindgen. Don't modify this manually. */"
+header = """
+/*
+ * Copyright (C) 2022 Vaticle
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+"""
+trailer = "/** @file */ // Tells doxygen to document this file."
+documentation = true
+documentation_style = "doxy"
 
 [parse]
 parse_deps = true