From fd609e0796a6d8b4b1d3163a08c964bc80b85882 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Agust=C3=ADn=20Borgna?=
 <121866228+aborgna-q@users.noreply.github.com>
Date: Fri, 2 Aug 2024 11:27:41 +0100
Subject: [PATCH] chore: Only release-plz after release PRs (#1391)

Stops releases from being created by new packages pushed to `main`.

https://release-plz.ieni.dev/docs/config#the-release_always-field

This saves us from having to temporarily configure `git_tag_enable` and
`git_release_enable` for each crate.
https://github.com/CQCL/tket2/pull/519/commits/73d6e651c7cebc6758ac7957a6ff9c7aee1f9419


Copied from https://github.com/CQCL/tket2/pull/524
---
 release-plz.toml | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/release-plz.toml b/release-plz.toml
index 4a4d4a902..d868bc081 100644
--- a/release-plz.toml
+++ b/release-plz.toml
@@ -15,6 +15,13 @@ changelog_config = "cliff.toml"
 git_tag_name = "{{ package }}-v{{ version }}"
 git_release_name = "{{ package }}: v{{ version }}"
 
+# Only create releases / push to crates.io after merging a release-please PR.
+# This lets merge new crates to `main` without worrying about accidentally creating
+# github releases.
+#
+# To trigger a release manually, merge a PR from a branch starting with `release-plz-`.
+release_always = false
+
 [[package]]
 name = "hugr"
 changelog_include = ["hugr-core", "hugr-passes"]