From 4612f9de61d644429c4c61cdd07b790b8c741bc7 Mon Sep 17 00:00:00 2001 From: Antoni Ivanov Date: Tue, 23 Aug 2022 18:20:38 +0300 Subject: [PATCH 1/5] versatile-data-kit: simplify release process Remove the step that requires making extra release. It's unnecessary as we can record the version at the time of release as the one corresponding to the release. It would have made some sense if we tagged the commit with the release but we do not do that for now , so it's just extra step Signed-off-by: Antoni Ivanov --- CONTRIBUTING.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d9cb0b6ec0..2c160b0294 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -145,18 +145,14 @@ We aim to make a new public release every few weeks. To make a new public release, follow these steps: - Create a new release from the Releases menu - this will require a new tag; - Autogenerate the changelog (https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes), then sort the changes alphabetically; if all change names are prefixed with the component name, this will ensure changes are grouped by component. Sorting can be done using the `sort` utility available in MacOS and Linux distros; Clean up unnecessary commits (e.g automated commits like pre-commit.ci) -- Review which components have received changes since the previous release - this should be apparent from the changelog; - Write a summary at the top of the release page. It should include sections: - Major features include - Backwards incompatible changes - Removal of features -- Create a new PR which bumps the minor versions of all newly changed components: - - plugins' version source of truth is located inside their respective `setup.py` files; - - vdk-core's version source of truth is located [here](projects/vdk-core/version.txt); - - vdk-heartbeat's version source of truth is located [here](projects/vdk-heartbeat/version.txt); - - vdk-control-cli's version source of truth is located [here](projects/vdk-control-cl/version.txt); - - control-service's version source of truth is located [here](projects/control-service/projects/helm_charts/pipelines-control-service/version.txt); -- Record the new versions as they are released and list them in the Release description; +- Review which components have received changes since the previous release - this should be apparent from the changelog; +- Record the latest versions of the components included in teh release (from the auto generated notes) and list them in the Release description; + - You can see the current version (as of time of release) of python distribution in https://pypi.org/search/?q= + - You can see the current version (as of time of release) of control service in [helm repo here](https://gitlab.com/vmware-analytics/versatile-data-kit-helm-registry/-/packages) - Make sure you have clicked the "Create a discussion for this release" button before publishing the new release - Post a tweet on the official VDK Twitter account, and on slack, announcing the new release and linking to it. From 5c1dcdd6c92a44393f81c41d7aa6dd2ad4d3f520 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 23 Aug 2022 15:23:37 +0000 Subject: [PATCH 2/5] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2c160b0294..bb87053844 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -151,7 +151,7 @@ To make a new public release, follow these steps: - Removal of features - Review which components have received changes since the previous release - this should be apparent from the changelog; - Record the latest versions of the components included in teh release (from the auto generated notes) and list them in the Release description; - - You can see the current version (as of time of release) of python distribution in https://pypi.org/search/?q= + - You can see the current version (as of time of release) of python distribution in https://pypi.org/search/?q= - You can see the current version (as of time of release) of control service in [helm repo here](https://gitlab.com/vmware-analytics/versatile-data-kit-helm-registry/-/packages) - Make sure you have clicked the "Create a discussion for this release" button before publishing the new release - Post a tweet on the official VDK Twitter account, and on slack, announcing the new release and linking to it. From 550dd0aec2a4665152586e6674754a6d835b2f5b Mon Sep 17 00:00:00 2001 From: Antoni Ivanov Date: Wed, 24 Aug 2022 18:19:42 +0300 Subject: [PATCH 3/5] Update CONTRIBUTING.md Co-authored-by: Gabriel Georgiev <45939426+gageorgiev@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bb87053844..bc8c172e07 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -150,7 +150,7 @@ To make a new public release, follow these steps: - Backwards incompatible changes - Removal of features - Review which components have received changes since the previous release - this should be apparent from the changelog; -- Record the latest versions of the components included in teh release (from the auto generated notes) and list them in the Release description; +- Record the latest versions of the components included in the release (from the auto generated notes) and list them in the Release description; - You can see the current version (as of time of release) of python distribution in https://pypi.org/search/?q= - You can see the current version (as of time of release) of control service in [helm repo here](https://gitlab.com/vmware-analytics/versatile-data-kit-helm-registry/-/packages) - Make sure you have clicked the "Create a discussion for this release" button before publishing the new release From 1f1a151acb841841cdf1581b945a74801dbc1edb Mon Sep 17 00:00:00 2001 From: Antoni Ivanov Date: Wed, 24 Aug 2022 18:19:48 +0300 Subject: [PATCH 4/5] Update CONTRIBUTING.md Co-authored-by: Gabriel Georgiev <45939426+gageorgiev@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bc8c172e07..8d9f8266f3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -151,7 +151,7 @@ To make a new public release, follow these steps: - Removal of features - Review which components have received changes since the previous release - this should be apparent from the changelog; - Record the latest versions of the components included in the release (from the auto generated notes) and list them in the Release description; - - You can see the current version (as of time of release) of python distribution in https://pypi.org/search/?q= + - You can see the current version (as of time of release) of a Python package in https://pypi.org/search/?q= - You can see the current version (as of time of release) of control service in [helm repo here](https://gitlab.com/vmware-analytics/versatile-data-kit-helm-registry/-/packages) - Make sure you have clicked the "Create a discussion for this release" button before publishing the new release - Post a tweet on the official VDK Twitter account, and on slack, announcing the new release and linking to it. From 19e12a60c19725eed260b720dc46cc7f13a45659 Mon Sep 17 00:00:00 2001 From: Antoni Ivanov Date: Wed, 24 Aug 2022 18:19:54 +0300 Subject: [PATCH 5/5] Update CONTRIBUTING.md Co-authored-by: Gabriel Georgiev <45939426+gageorgiev@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8d9f8266f3..2ac69fd715 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -152,7 +152,7 @@ To make a new public release, follow these steps: - Review which components have received changes since the previous release - this should be apparent from the changelog; - Record the latest versions of the components included in the release (from the auto generated notes) and list them in the Release description; - You can see the current version (as of time of release) of a Python package in https://pypi.org/search/?q= - - You can see the current version (as of time of release) of control service in [helm repo here](https://gitlab.com/vmware-analytics/versatile-data-kit-helm-registry/-/packages) + - You can see the current version (as of time of release) of the Control Service in [the helm repo here](https://gitlab.com/vmware-analytics/versatile-data-kit-helm-registry/-/packages) - Make sure you have clicked the "Create a discussion for this release" button before publishing the new release - Post a tweet on the official VDK Twitter account, and on slack, announcing the new release and linking to it.