From 4885cfbb8855e45f8419b7a12865c2abacbd9a03 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Saparelli?= Date: Mon, 5 Sep 2022 16:47:20 +1200 Subject: [PATCH] Add important usage note for triggering builds to release template (#345) --- .github/scripts/release-pr-template.ejs | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/.github/scripts/release-pr-template.ejs b/.github/scripts/release-pr-template.ejs index aefae9a85..5157379bb 100644 --- a/.github/scripts/release-pr-template.ejs +++ b/.github/scripts/release-pr-template.ejs @@ -19,18 +19,28 @@ This is a release PR for **<%= crate.name %>** version **<%= version.actual %>** <% } %> <% if (crate.name == "cargo-binstall") { %> -Upon merging, this will automatically build the CLI and create a GitHub release. -<% } else { %> -Upon merging, this will create the tag `<%= crate.name %>-<%= version.actual %>`. -<% } %> +Upon merging, this will automatically create the tag `v<%= version.actual %>`, build the CLI, and create a GitHub release. +You will still need to manually publish the cargo crate: +``` +$ git switch main +$ git pull +$ git switch --detach v<%= version.actual %> +$ cargo publish -p <%= crate.name %> +``` +<% } else { %> +Upon merging, this will create the tag `<%= crate.name %>-v<%= version.actual %>`. You will still need to manually publish the cargo crate: ``` +$ git switch main $ git pull -$ git switch --detach <%= crate.name %>-<%= version.actual %> +$ git switch --detach <%= crate.name %>-v<%= version.actual %> $ cargo publish -p <%= crate.name %> ``` +<% } %> + +**To trigger builds initially, close and then immediately re-open this PR once.** <% if (pr.releaseNotes) { %> ---