From 1cf302675518ae18ba355de54171be68a6972a17 Mon Sep 17 00:00:00 2001 From: Max Opperman <55201171+oppermax@users.noreply.github.com> Date: Wed, 4 Jan 2023 17:17:52 +0100 Subject: [PATCH 1/2] don't run release on push to main --- .github/workflows/release.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 016b615..cf71374 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -12,7 +12,6 @@ name: release on: push: - branches: [ main ] tags: - 'v*' jobs: From ea160b07a399ce5213ca5962a947f5209ccc0670 Mon Sep 17 00:00:00 2001 From: Max Opperman <55201171+oppermax@users.noreply.github.com> Date: Wed, 4 Jan 2023 17:23:30 +0100 Subject: [PATCH 2/2] update docs --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 912f88b..1e4fe75 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,13 @@ provider. To specify a particular provider version when installing released prov To instead use a custom-built provider in your Terraform environment (e.g. the provider binary from the build instructions above), follow the instructions to [install it as a plugin](https://www.terraform.io/docs/plugins/basics.html#installing-plugins). After placing the custom-built provider into your plugins' directory, run `terraform init` to initialize it. +## Releasing a new provider version + +The release of the provider is done automatically with a [GitHub action](.github/workflows/release.yaml). The workflow gets triggered if a new tag is created. +Tags can be created with the GitHub web UI or the command line. + +The release is signed with a GPG key that is stored as a repository secret and in [terraform](https://registry.terraform.io/providers/moia-oss/opensearch-dashboards/). + ## Contributing We really appreciate your help!