Update release notes workflow (#291)

dmitrii-ubskii · web-flow · commit 517890f69bc3 · 2023-05-31T08:42:17.000+01:00
## What is the goal of this PR?

We integrate the new release notes tooling. The release notes are now to be written by a person and committed to the repo.

## What are the changes implemented in this PR?

`tools/release/create_notes.sh` is a manual replacement for automatic `@vaticle_dependencies//tool/release/notes:create` in CI. The script is meant to be executed manually by the writer of the release notes, who will edit the autocompiled notes before committing LATEST_RELEASE_NOTES.md to the repository.

In the Release job in Factory, we check to see whether there were any changes committed since the release notes have last been changed, as a safeguard against accidentally releasing with stale release notes.
diff --git a/.factory/automation.yml b/.factory/automation.yml
@@ -265,6 +265,11 @@ release:
     validate-dependencies:
       image: vaticle-ubuntu-22.04
       command: bazel test //:release-validate-python-deps --test_output=streamed
+    validate-release-notes:
+      image: vaticle-ubuntu-22.04
+      command: |
+        export NOTES_VALIDATE_TOKEN=$REPO_GITHUB_TOKEN
+        bazel run @vaticle_dependencies//tool/release/notes:validate --test_output=streamed -- $FACTORY_OWNER $FACTORY_REPO ./RELEASE_NOTES_LATEST.md
   deployment:
     deploy-github:
       image: vaticle-ubuntu-22.04
@@ -279,8 +284,6 @@ release:
         export ARTIFACT_USERNAME=$REPO_VATICLE_USERNAME
         export ARTIFACT_PASSWORD=$REPO_VATICLE_PASSWORD
         bazel run @vaticle_dependencies//distribution/artifact:create-netrc
-        export NOTES_CREATE_TOKEN=$REPO_GITHUB_TOKEN
-        bazel run @vaticle_dependencies//tool/release/notes:create -- $FACTORY_OWNER $FACTORY_REPO $FACTORY_COMMIT $(cat VERSION) ./RELEASE_TEMPLATE.md
         export DEPLOY_GITHUB_TOKEN=$REPO_GITHUB_TOKEN
         bazel run --define version=$(cat VERSION) //:deploy-github -- $FACTORY_COMMIT
     deploy-pip-release:
diff --git a/BUILD b/BUILD
@@ -19,7 +19,7 @@
 # under the License.
 #
 
-exports_files(["requirements.txt", "deployment.bzl", "RELEASE_TEMPLATE.md"])
+exports_files(["requirements.txt", "deployment.bzl"])
 
 load("@vaticle_typedb_client_python_pip//:requirements.bzl",
        vaticle_typedb_client_python_requirement = "requirement")
@@ -99,7 +99,7 @@ deploy_pip(
 
 deploy_github(
     name = "deploy-github",
-    release_description = "//:RELEASE_TEMPLATE.md",
+    release_description = "//:RELEASE_NOTES_LATEST.md",
     title = "TypeDB Client Python",
     title_append_version = True,
     organisation = github_deployment["github.organisation"],
diff --git a/RELEASE_NOTES_LATEST.md b/RELEASE_NOTES_LATEST.md
diff --git a/dependencies/vaticle/repositories.bzl b/dependencies/vaticle/repositories.bzl
@@ -25,14 +25,14 @@ def vaticle_dependencies():
     git_repository(
         name = "vaticle_dependencies",
         remote = "https://github.com/vaticle/dependencies",
-        commit = "385716283e1e64245c3679a06054e271a0608ac1", # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_dependencies
+        commit = "51fdda8c935d5f9fc34bfdf41b0a6ac1ca77e2ee", # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_dependencies
     )
 
 def vaticle_typedb_common():
     git_repository(
         name = "vaticle_typedb_common",
         remote = "https://github.com/vaticle/typedb-common",
-        commit = "9372dfb227d54c6eb631eed02e67f250e55e657e" # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_typedb_common
+        tag = "2.18.0" # sync-marker: do not remove this comment, this is used for sync-dependencies by @vaticle_typedb_common
     )
 
 def vaticle_typedb_behaviour():
diff --git a/tests/BUILD b/tests/BUILD
@@ -20,7 +20,7 @@
 #
 
 # Note: Do NOT rename this folder to 'test' as it conflicts with a built-in Python package!
-load("//tools:cluster_test_rule.bzl", "typedb_cluster_py_test")
+load("//tool:cluster_test_rule.bzl", "typedb_cluster_py_test")
 load("@vaticle_bazel_distribution//artifact:rules.bzl", "artifact_extractor")
 load("@vaticle_typedb_common//test:rules.bzl", "native_typedb_artifact")
 load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
diff --git a/tests/behaviour/concept/serialization/json/BUILD b/tests/behaviour/concept/serialization/json/BUILD
@@ -20,7 +20,7 @@
 #
 
 package(default_visibility = ["//tests/behaviour:__subpackages__"])
-load("//tools:behave_rule.bzl", "typedb_behaviour_py_test")
+load("//tool:behave_rule.bzl", "typedb_behaviour_py_test")
 load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
 
 py_library(
diff --git a/tests/behaviour/concept/thing/attribute/BUILD b/tests/behaviour/concept/thing/attribute/BUILD
@@ -20,7 +20,7 @@
 #
 
 package(default_visibility = ["//tests/behaviour:__subpackages__"])
-load("//tools:behave_rule.bzl", "typedb_behaviour_py_test")
+load("//tool:behave_rule.bzl", "typedb_behaviour_py_test")
 load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
 
 py_library(
diff --git a/tests/behaviour/concept/thing/entity/BUILD b/tests/behaviour/concept/thing/entity/BUILD
@@ -20,7 +20,7 @@
 #
 
 package(default_visibility = ["//tests/behaviour:__subpackages__"])
-load("//tools:behave_rule.bzl", "typedb_behaviour_py_test")
+load("//tool:behave_rule.bzl", "typedb_behaviour_py_test")
 load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
 
 py_library(
diff --git a/tests/behaviour/concept/thing/relation/BUILD b/tests/behaviour/concept/thing/relation/BUILD
@@ -20,7 +20,7 @@
 #
 
 package(default_visibility = ["//tests/behaviour:__subpackages__"])
-load("//tools:behave_rule.bzl", "typedb_behaviour_py_test")
+load("//tool:behave_rule.bzl", "typedb_behaviour_py_test")
 load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
 
 py_library(
diff --git a/tests/behaviour/concept/type/attributetype/BUILD b/tests/behaviour/concept/type/attributetype/BUILD
@@ -20,7 +20,7 @@
 #
 
 package(default_visibility = ["//tests/behaviour:__subpackages__"])
-load("//tools:behave_rule.bzl", "typedb_behaviour_py_test")
+load("//tool:behave_rule.bzl", "typedb_behaviour_py_test")
 load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
 
 py_library(
diff --git a/tests/behaviour/concept/type/entitytype/BUILD b/tests/behaviour/concept/type/entitytype/BUILD
@@ -20,7 +20,7 @@
 #
 
 package(default_visibility = ["//tests/behaviour:__subpackages__"])
-load("//tools:behave_rule.bzl", "typedb_behaviour_py_test")
+load("//tool:behave_rule.bzl", "typedb_behaviour_py_test")
 load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
 
 typedb_behaviour_py_test(
diff --git a/tests/behaviour/concept/type/relationtype/BUILD b/tests/behaviour/concept/type/relationtype/BUILD
@@ -20,7 +20,7 @@
 #
 
 package(default_visibility = ["//tests/behaviour:__subpackages__"])
-load("//tools:behave_rule.bzl", "typedb_behaviour_py_test")
+load("//tool:behave_rule.bzl", "typedb_behaviour_py_test")
 load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
 
 py_library(
diff --git a/tests/behaviour/concept/type/thingtype/BUILD b/tests/behaviour/concept/type/thingtype/BUILD
@@ -20,7 +20,7 @@
 #
 
 package(default_visibility = ["//tests/behaviour:__subpackages__"])
-load("//tools:behave_rule.bzl", "typedb_behaviour_py_test")
+load("//tool:behave_rule.bzl", "typedb_behaviour_py_test")
 load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
 
 py_library(
diff --git a/tests/behaviour/connection/database/BUILD b/tests/behaviour/connection/database/BUILD
@@ -20,7 +20,7 @@
 #
 
 package(default_visibility = ["//tests/behaviour:__subpackages__"])
-load("//tools:behave_rule.bzl", "typedb_behaviour_py_test")
+load("//tool:behave_rule.bzl", "typedb_behaviour_py_test")
 load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
 
 py_library(
diff --git a/tests/behaviour/connection/session/BUILD b/tests/behaviour/connection/session/BUILD
@@ -20,7 +20,7 @@
 #
 
 package(default_visibility = ["//tests/behaviour:__subpackages__"])
-load("//tools:behave_rule.bzl", "typedb_behaviour_py_test")
+load("//tool:behave_rule.bzl", "typedb_behaviour_py_test")
 load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
 
 py_library(
diff --git a/tests/behaviour/connection/transaction/BUILD b/tests/behaviour/connection/transaction/BUILD
@@ -20,7 +20,7 @@
 #
 
 package(default_visibility = ["//tests/behaviour:__subpackages__"])
-load("//tools:behave_rule.bzl", "typedb_behaviour_py_test")
+load("//tool:behave_rule.bzl", "typedb_behaviour_py_test")
 load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
 
 py_library(
diff --git a/tests/behaviour/connection/user/BUILD b/tests/behaviour/connection/user/BUILD
@@ -20,7 +20,7 @@
 #
 
 package(default_visibility = ["//tests/behaviour:__subpackages__"])
-load("//tools:behave_rule.bzl", "typedb_behaviour_py_test")
+load("//tool:behave_rule.bzl", "typedb_behaviour_py_test")
 load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
 
 py_library(
diff --git a/tests/behaviour/typeql/language/define/BUILD b/tests/behaviour/typeql/language/define/BUILD
@@ -20,7 +20,7 @@
 #
 
 package(default_visibility = ["//tests/behaviour:__subpackages__"])
-load("//tools:behave_rule.bzl", "typedb_behaviour_py_test")
+load("//tool:behave_rule.bzl", "typedb_behaviour_py_test")
 load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
 
 typedb_behaviour_py_test(
diff --git a/tests/behaviour/typeql/language/delete/BUILD b/tests/behaviour/typeql/language/delete/BUILD
@@ -20,7 +20,7 @@
 #
 
 package(default_visibility = ["//tests/behaviour:__subpackages__"])
-load("//tools:behave_rule.bzl", "typedb_behaviour_py_test")
+load("//tool:behave_rule.bzl", "typedb_behaviour_py_test")
 load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
 
 typedb_behaviour_py_test(
diff --git a/tests/behaviour/typeql/language/expression/BUILD b/tests/behaviour/typeql/language/expression/BUILD
@@ -20,7 +20,7 @@
 #
 
 package(default_visibility = ["//tests/behaviour:__subpackages__"])
-load("//tools:behave_rule.bzl", "typedb_behaviour_py_test")
+load("//tool:behave_rule.bzl", "typedb_behaviour_py_test")
 load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
 
 typedb_behaviour_py_test(
diff --git a/tests/behaviour/typeql/language/get/BUILD b/tests/behaviour/typeql/language/get/BUILD
@@ -20,7 +20,7 @@
 #
 
 package(default_visibility = ["//tests/behaviour:__subpackages__"])
-load("//tools:behave_rule.bzl", "typedb_behaviour_py_test")
+load("//tool:behave_rule.bzl", "typedb_behaviour_py_test")
 load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
 
 typedb_behaviour_py_test(
diff --git a/tests/behaviour/typeql/language/insert/BUILD b/tests/behaviour/typeql/language/insert/BUILD
@@ -20,7 +20,7 @@
 #
 
 package(default_visibility = ["//tests/behaviour:__subpackages__"])
-load("//tools:behave_rule.bzl", "typedb_behaviour_py_test")
+load("//tool:behave_rule.bzl", "typedb_behaviour_py_test")
 load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
 
 typedb_behaviour_py_test(
diff --git a/tests/behaviour/typeql/language/match/BUILD b/tests/behaviour/typeql/language/match/BUILD
@@ -20,7 +20,7 @@
 #
 
 package(default_visibility = ["//tests/behaviour:__subpackages__"])
-load("//tools:behave_rule.bzl", "typedb_behaviour_py_test")
+load("//tool:behave_rule.bzl", "typedb_behaviour_py_test")
 load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
 
 typedb_behaviour_py_test(
diff --git a/tests/behaviour/typeql/language/undefine/BUILD b/tests/behaviour/typeql/language/undefine/BUILD
@@ -20,7 +20,7 @@
 #
 
 package(default_visibility = ["//tests/behaviour:__subpackages__"])
-load("//tools:behave_rule.bzl", "typedb_behaviour_py_test")
+load("//tool:behave_rule.bzl", "typedb_behaviour_py_test")
 load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
 
 typedb_behaviour_py_test(
diff --git a/tests/behaviour/typeql/language/update/BUILD b/tests/behaviour/typeql/language/update/BUILD
@@ -20,7 +20,7 @@
 #
 
 package(default_visibility = ["//tests/behaviour:__subpackages__"])
-load("//tools:behave_rule.bzl", "typedb_behaviour_py_test")
+load("//tool:behave_rule.bzl", "typedb_behaviour_py_test")
 load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
 
 typedb_behaviour_py_test(
diff --git a/tests/integration/BUILD b/tests/integration/BUILD
@@ -19,7 +19,7 @@
 # under the License.
 #
 
-load("//tools:cluster_test_rule.bzl", "typedb_cluster_py_test")
+load("//tool:cluster_test_rule.bzl", "typedb_cluster_py_test")
 load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
 load("@rules_python//python:defs.bzl", "py_test")
 
diff --git a/tool/BUILD b/tool/BUILD
diff --git a/tool/behave_rule.bzl b/tool/behave_rule.bzl
diff --git a/tool/cluster_test_rule.bzl b/tool/cluster_test_rule.bzl
diff --git a/tool/release/BUILD b/tool/release/BUILD
@@ -0,0 +1,29 @@
+#
+# 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.
+#
+
+load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")
+
+checkstyle_test(
+    name = "checkstyle",
+    include = glob(["*"]),
+    license_type = "apache-header",
+)
+
diff --git a/tool/release/create_notes.sh b/tool/release/create_notes.sh
@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+#
+# 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.
+#
+
+bazel run @vaticle_dependencies//tool/release/notes:create -- vaticle typedb-client-python HEAD $(cat VERSION) ./RELEASE_TEMPLATE.md ./RELEASE_NOTES_LATEST.md

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`#`
`21`	`21`
`22`	`22`	`# Note: Do NOT rename this folder to 'test' as it conflicts with a built-in Python package!`
`23`		`-load("//tools:cluster_test_rule.bzl", "typedb_cluster_py_test")`
	`23`	`+load("//tool:cluster_test_rule.bzl", "typedb_cluster_py_test")`
`24`	`24`	`load("@vaticle_bazel_distribution//artifact:rules.bzl", "artifact_extractor")`
`25`	`25`	`load("@vaticle_typedb_common//test:rules.bzl", "native_typedb_artifact")`
`26`	`26`	`load("@vaticle_dependencies//tool/checkstyle:rules.bzl", "checkstyle_test")`