chore(release): set up conventional commit changelog tool. Part of #3920

.github/pull_request_template.md

@@ -2,6 +2,14 @@
 
 
 **Checklist:**
+- [ ] PR title should follow our convention. Examples:
+    * `"fix(frontend): fixes empty page. Fixes #1234"`
+    * `"feat(backend): configurable service account. Fixes #1234, fixes #1235"`
+    * `"chore: refactor some files"`
+    * `"test: fix CI failure. Part of #1234"` // use "part of" when a PR is an work item of some issue, but shouldn't close the issue when merged.
+
+    Read more about the format we use in [CONTRIBUTING.md](https://github.com/kubeflow/pipelines/blob/master/CONTRIBUTING.md#pull-request-title-convention).
+
 - [ ] Do you want this PR cherry picked to release branch?
 
     If yes, please either

CONTRIBUTING.md

@@ -28,6 +28,66 @@ use GitHub pull requests for this purpose. Consult
 [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
 information on using pull requests.
 
+## Pull Request Title Convention
+
+We enforce a PR title convention to quickly indicate type and scope of a PR.
+We also parse it programmatically for changelog generation.
+
+PR titles should
+* be a user facing description of the change
+* be [conventional](https://www.conventionalcommits.org/en/v1.0.0/)
+* append fixed issue(s) at the end (if any)
+
+Examples:
+* `"fix(ui): fixes empty page. Fixes #1234"`
+* `"feat(backend): configurable service account. Fixes #1234, fixes #1235"`
+* `"chore: refactor some files"`
+* `"test: fix CI failure. Part of #1234"` // use "part of" when a PR is an work item of some issue, but shouldn't close the issue when merged.
+
+A quick summary of the conventions we care about:
+### PR Title Structure
+```
+<type>[optional scope]: <description> [Fixes #<issue-number>]
+```
+### PR Type
+Type can be one of
+* feat: A new feature
+* fix: A bug fix (however a bug fix to test infra is not user facing, so it should be test type instead)
+* docs: Documentation only changes
+* chore: Anything else that do not need to be user facing
+* test: Adding missing tests or correcting existing tests
+* refactor: A code change that neither fixes a bug nor adds a feature
+* perf: A code change that improves performance
+
+Note, only feature and fix type PRs will be included in CHANGELOG, because they are
+user facing.
+
+If you think the PR contains multiple types, you can choose the major one or
+split the PR to focused sub-PRs.
+
+If you are not sure which type your PR is and it does not have user impact,
+use `chore` as the fallback.
+
+### PR Scope
+Scope is optional, it can be one of
+* frontend - UI or UI server related, folder `frontend`, `frontend/server`
+* backend - Backend, folder `backend`
+* sdk - `kfp` python package, folder `sdk`
+* sdk/client - `kfp-server-api` python package, folder `backend/api/python_http_client`
+* components - Pipeline components, folder `components`
+* deployment - Kustomize or gcp marketplace manifests, folder `manifests`
+* metadata - Related to machine learning metadata (MLMD), folder `backend/metadata_writer`
+* cache - Caching, folder `backend/src/cache`
+* swf - Scheduled workflow, folder `backend/src/crd/controller/scheduledworkflow`
+* viewer - Tensorboard viewer, folder `backend/src/crd/controller/viewer`
+
+If you think the PR is related to multiple scopes, you can choose the major one or
+split the PR to focused sub-PRs. Note, suggest splitting a huge PR because different scopes
+usually have different reviewers, it helps getting through the review process faster too.
+
+If you are not sure, or the PR doesn't fit into above scopes. You can either
+omit the scope because it's optional, or propose an additional scope here.
+
 ## Community Guidelines
 
 This project follows

VERSION

@@ -1 +1 @@
-1.0.0-dev.2
+1.0.0-dev.2

hack/check-release-needed-tools.sh

@@ -17,18 +17,21 @@
 set -e
 
 echo "The following tools are needed when releasing KFP:"
+echo "node==12"
+which node >/dev/null || (echo "node not found in PATH, recommend install via https://github.com/nvm-sh/nvm#installing-and-updating" && exit 1)
+node -v | grep v12 || (echo "node not v12.x version" && exit 1)
 echo "jq>=1.6"
-which jq || (echo "jq not found in PATH" && exit 1)
+which jq >/dev/null || (echo "jq not found in PATH" && exit 1)
 echo "yq>=3.3"
-which yq || (echo "yq not found in PATH" && exit 1)
+which yq >/dev/null || (echo "yq not found in PATH" && exit 1)
 yq -V | grep 3. || (echo "yq version 3.x should be used" && exit 1)
 echo "java>=8"
-which java || (echo "java not found in PATH" && exit 1)
+which java >/dev/null || (echo "java not found in PATH" && exit 1)
 echo "bazel==0.24.0"
-which bazel || (echo "bazel not found in PATH" && exit 1)
+which bazel >/dev/null || (echo "bazel not found in PATH" && exit 1)
 bazel version | grep 0.24.0 || (echo "bazel not 0.24.0 version" && exit 1)
 echo "python>3"
-which python || (echo "python not found in PATH" && exit 1)
+which python >/dev/null || (echo "python not found in PATH" && exit 1)
 python -c "import setuptools" || (echo "setuptools should be installed in python" && exit 1)
 
 echo "All tools installed"

hack/release-imp.sh

@@ -16,7 +16,10 @@
 
 set -ex
 
-echo "Usage: edit kubeflow/pipelines/VERSION to new version tag first, then run this script."
+echo "Usage: update kubeflow/pipelines/VERSION to new version tag by"
+echo '`echo -n "\$VERSION" > VERSION` first, then run this script.'
+echo "Please use the above command to make sure the file doesn't have extra"
+echo "line endings."
 
 DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" > /dev/null && pwd)"
 REPO_ROOT="$DIR/.."
@@ -29,6 +32,14 @@ fi
 
 "$DIR/check-release-needed-tools.sh"
 
+pushd "$REPO_ROOT"
+npm ci
+npm run changelog
+popd
+# Change github issue/PR references like #123 to real urls in markdown.
+# The issues must have a " " or a "(" before it to avoid already converted issues like [\#123](url...).
+sed -i.bak -e 's|\([ (]\)#\([0-9]\+\)|\1[\\#\2](https://github.com/kubeflow/pipelines/issues/\2)|g' "$REPO_ROOT/CHANGELOG.md"
+
 "$REPO_ROOT/components/release-in-place.sh" $TAG_NAME
 "$REPO_ROOT/manifests/gcp_marketplace/hack/release.sh" $TAG_NAME
 "$REPO_ROOT/manifests/kustomize/hack/release.sh" $TAG_NAME

hack/release.sh

@@ -31,7 +31,7 @@ git clone "git@github.com:${REPO}.git" "$clone_dir"
 cd "$clone_dir"
 git checkout "$BRANCH"
 
-echo "$TAG_NAME" > ./VERSION
+echo -n "$TAG_NAME" > ./VERSION
 # Run the release script in cloned repo
 "hack/release-imp.sh" $TAG_NAME