Release process guidance for VictoriaLogs #

Pre-reqs #

For MacOS users #

Make sure you have GNU version of utilities zip, tar, sha256sum. To install them run the following commands:

      brew install coreutils
brew install gnu-tar
export PATH="/usr/local/opt/coreutils/libexec/gnubin:$PATH"
    

Docker may need additional configuration changes:

      docker buildx create --use --name=qemu
docker buildx inspect --bootstrap  
    

By default, docker on MacOS has limited amount of resources (CPU, mem) to use. Bumping the limits may significantly improve build speed.

Release version and Docker images #

1. Make sure all the changes are documented in CHANGELOG.md . Ideally, every change must be documented in the commit with the change. Alternatively, the change must be documented immediately after the commit, which adds the change.

2. Run make vmui-update command to re-build static files for the built-in Web UI and commit the changes to the VictoriaLogs repository.

3. Run PKG_TAG=v1.xx.y make docs-update-version command to update version help tooltips according to the contribution guide .

4. Cut new version in CHANGELOG.md and commit it. See example in this commit .

5. Make sure you get all changes fetched git fetch --all.

6. Create release tag with in the master branch with the following command: git tag -s v1.xx.y

7. Run TAG=v1.xx.y make publish-release. This command performs the following tasks:

   • a) Builds and packages binaries in *.tar.gz release archives with the corresponding _checksums.txt files inside bin directory. This step can be run manually with the command make release from the needed git tag.
   • b) Build and publish multi-platform Docker images for the given TAG. The multi-platform Docker image is built for the following platforms:
     • linux/amd64
     • linux/arm64
     • linux/arm
     • linux/ppc64le
     • linux/386 This step can be run manually with the command make publish from the needed git tag.

8. Run TAG=v1.xx.y make publish-latest for publishing the latest tag for Docker images, which equals to the given TAG.

9. Run TAG=v1.xx.y make github-create-release github-upload-assets. This command performs the following tasks:

   • a) Create draft GitHub release with the name TAG. This step can be run manually with the command TAG=v1.xx.y make github-create-release. The release id is stored at /tmp/vm-github-release file.
   • b) Upload all the binaries and checksums created at the previous steps to that release. This step can be run manually with the command make github-upload-assets. It is expected that the needed release id is stored at /tmp/vm-github-release file, which must be created at the step a. If the upload process is interrupted by any reason, then the following recovery steps must be performed:
     • To delete the created draft release by running the command make github-delete-release. This command expects that the id of the release to delete is located at /tmp/vm-github-release file created at the step a.
     • To run the command TAG=v1.xx.y make github-create-release github-upload-assets, so new release is created and all the needed assets are re-uploaded to it.

10. Push the tag v1.xx.y created at the previous steps to public GitHub repository at https://github.com/VictoriaMetrics/VictoriaLogs :

          git push origin v1.xx.y
        

11. Go to https://github.com/VictoriaMetrics/VictoriaLogs/releases and verify that draft release with the name TAG has been created and this release contains all the needed binaries and checksums.

12. Update the release description with the contents of CHANGELOG for this release.

13. Publish release by pressing “Publish release” button in GitHub’s UI.

14. Update GitHub issues related to the new release - they are mentioned in the CHANGELOG . Put human-readable description on how the issue has been addressed and which particular release contains the change.

15. Bump VictoriaLogs version at deployment/docker/*.yml. For example:

          for f in $(grep "v1\.116\.0" -R deployment/docker/ -l); do sed -i 's/v1.116.0/v1.117.0/g' $f; done
        

16. Bump VictoriaLogs version mentioned in docs .

Operator #

The operator repository https://github.com/VictoriaMetrics/operator/

Bump the version of images #

• Bump the VictoriaLogs version in file internal/config/config.go with new release version for:
  • VM_LOGS_VERSION key in defaultEnvs map,
  • BaseOperatorConf.LogsVersion default value.
• Run make docs.
• Add the dependency to the new release to the tip section in docs/CHANGELOG.md (example ).
• Commit and send a PR for review.

Helm Charts #

The helm chart repository https://github.com/VictoriaMetrics/helm-charts/

Bump the version of images #

Bump appVersion field in Chart.yaml with new release version. Add new line to “Next release” section in CHANGELOG.md about version update (the line must always start with “-”). Do NOT change headers in CHANGELOG.md. Bump version field in Chart.yaml with incremental semver version (based on the CHANGELOG.md analysis).

Do these updates to the following charts:

1. Update victoria-logs-single chart version and appVersion in Chart.yaml
2. Update victoria-logs-cluster chart version and appVersion in Chart.yaml

See commit example here .

Once updated, run the following commands:

1. Commit and push changes to master.
2. Run “Release” action on Github.
3. Merge new PR “Automatic update CHANGELOGs and READMEs” after pipelines are complete.

Ansible Roles #

1. Update the version of VictoriaLogs components at https://github.com/VictoriaMetrics/ansible-playbooks .
2. Commit changes.
3. Create a new tag with git tag -sm <TAG> <TAG>.
4. Push the changes with the new tag. This automatically publishes the new versions to galaxy.ansible.com.