From 4e285375bc8d49ef4e659ab9bf01bb844babdc40 Mon Sep 17 00:00:00 2001 From: David Harris Date: Wed, 21 Feb 2024 10:23:49 +0000 Subject: [PATCH] docs: Update set-up-github-workflows.md (#734) Co-authored-by: Joseph Perez <45749060+josmperez@users.noreply.github.com> --- .../develop-a-plugin/set-up-github-workflows.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docusaurus/docs/create-a-plugin/develop-a-plugin/set-up-github-workflows.md b/docusaurus/docs/create-a-plugin/develop-a-plugin/set-up-github-workflows.md index fd2ad0367..876ddab1f 100644 --- a/docusaurus/docs/create-a-plugin/develop-a-plugin/set-up-github-workflows.md +++ b/docusaurus/docs/create-a-plugin/develop-a-plugin/set-up-github-workflows.md @@ -22,11 +22,15 @@ The CI (`ci.yml`) workflow is designed to lint, type check, and build the fronte ## The release workflow +The release (`release.yml`) workflow is designed to build, test, package and sign your plugin whenever you're ready to release a new version. This automates the process of creating releases in GitHub and provides instructions for submitting the plugin to the Grafana plugin catalog. + :::warning This workflow requires a Grafana Cloud API key. Before you begin, follow the instructions for [generating an Access Policy token](../../publish-a-plugin/sign-a-plugin#generate-an-access-policy-token). -You can store your Access Policy token as a Repository Secret in GitHub: +::: + +### Storing your Access Policy token as a repository secret in GitHub 1. Access Repository Settings: @@ -60,9 +64,7 @@ jobs: In this example, the `secrets.GRAFANA_ACCESS_POLICY_TOKEN` variable is used to access the stored token securely within your GitHub Actions workflow. Make sure to adjust the workflow according to your specific needs and the language/environment you are working with. -::: - -The release (`release.yml`) workflow is designed to create a new release of your plugin whenever you're ready to publish a new version to Grafana Cloud. This automates the process of creating releases in GitHub and provides instructions for submitting the plugin to the Grafana plugin catalog. +### Triggering the workflow To trigger the release workflow, push a Git tag for the plugin version that you want to release: