Skip to content

Commit

Permalink
versatile-data-kit: update release process (#729)
Browse files Browse the repository at this point in the history
* versatile-data-kit: update release process
  • Loading branch information
antoniivanov authored Feb 22, 2022
1 parent 2bdeab4 commit 6949d0d
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,12 +100,17 @@ For more details see the [CICD wiki in our Dev Guide](https://github.com/vmware/

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;
- 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 major changes . 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;
- Post a tweet on the official VDK Twitter account, announcing the new release and linking to it.

0 comments on commit 6949d0d

Please sign in to comment.