From c803c8097ab586eb223b864e77175ba29b8b2651 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:30:28 +0100
Subject: [PATCH] chore: Only `release-plz` after release PRs (#524)

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
---
 release-plz.toml | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/release-plz.toml b/release-plz.toml
index 0163f770..13acf274 100644
--- a/release-plz.toml
+++ b/release-plz.toml
@@ -12,6 +12,13 @@ release = false
 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
+
 [changelog]
 sort_commits = "oldest"