From 2b47ab2c7a4bec8c2926e6b23dc118ed98523708 Mon Sep 17 00:00:00 2001 From: Nolan Brubaker Date: Tue, 13 Oct 2020 19:18:05 -0400 Subject: [PATCH] Add initial instructions for releasing plugins (#2952) * Add initial instructions for releasing plugins Signed-off-by: Nolan Brubaker * Document that goreleaser isn't needed Signed-off-by: Nolan Brubaker * Add link from core release instructions to plugins Signed-off-by: Nolan Brubaker * Add notes about updating compatibility matrix Signed-off-by: Nolan Brubaker * Add velero install note Signed-off-by: Nolan Brubaker * Address review feedback Signed-off-by: Nolan Brubaker * Remove anchor link to table, since it didn't work Signed-off-by: Nolan Brubaker --- .../docs/main/plugin-release-instructions.md | 17 +++++++++++++++++ site/content/docs/main/release-instructions.md | 4 ++++ 2 files changed, 21 insertions(+) create mode 100644 site/content/docs/main/plugin-release-instructions.md diff --git a/site/content/docs/main/plugin-release-instructions.md b/site/content/docs/main/plugin-release-instructions.md new file mode 100644 index 000000000..018a168c8 --- /dev/null +++ b/site/content/docs/main/plugin-release-instructions.md @@ -0,0 +1,17 @@ +--- +title: Releasing Velero plugins +layout: docs +toc: "true" +--- + +Velero plugins maintained by the core maintainers do not have any shipped binaries, only container images, so there is no need to invoke a GoReleaser script. +Container images are built via a CI job on git push. + +Plugins the Velero core team is responsible include all those listed in [the Velero-supported providers list](supported-providers.md) _except_ the vSphere plugin. + +1. Update the README.md file to update the compatibility matrix and `velero install` instructions with the expected version number and open a PR. + 1. Determining the version number is based on semantic versioning and whether the plugin uses any newly introduced, changed, or removed methods or variables from Velero. +1. Once the updated README.md PR is merged, checkout the upstream `main` branch. `git checkout upstream/main`. +1. Tag the git version - `git tag v`. +1. Push the git tag - `git push --tags ` +1. Wait for the container images to build diff --git a/site/content/docs/main/release-instructions.md b/site/content/docs/main/release-instructions.md index 25291cb84..7f8dc8494 100644 --- a/site/content/docs/main/release-instructions.md +++ b/site/content/docs/main/release-instructions.md @@ -97,6 +97,10 @@ These are the steps to update the Velero Homebrew version. - Run `export HOMEBREW_GITHUB_API_TOKEN=your_token_here` on your command line to make sure that `brew` can work on GitHub on your behalf. - Run `hack/release-tools/brew-update.sh`. This script will download the necessary files, do the checks, and invoke the brew helper to submit the PR, which will open in your browser. - Update Windows Chocolatey version. From a Windows computer, follow the step-by-step instructions to [create the Windows Chocolatey package for Velero CLI](https://github.com/adamrushuk/velero-choco/blob/main/README.md) +- +### Plugins + +To release plugins maintained by the core team, follow the [plugin release instructions](plugin-release-instructions.md). ## How to write and release a blog post What to include in a release blog: