add release instructions

This commit is contained in:
Kenneth Bingham 2023-11-01 15:02:19 -04:00
parent 99268276bb
commit 8066b28184
No known key found for this signature in database
GPG Key ID: 31709281860130B6

15
RELEASE.md Normal file
View File

@ -0,0 +1,15 @@
# Releasing zrok
## Manual Steps
1. Create a semver Git tag on main starting with a 'v' character
1. Push the tag to GitHub
## Automated Steps
1. The Release workflow is triggered by creating the Git tag and
1. uploads Linux packages to Artifactory and
1. creates a Release in GitHub Releases API.
1. The Publish Container Images workflow is triggered by the Releases API and
1. pushes Docker images to Docker Hub