Add important usage note for triggering builds to release template (#345)

This commit is contained in:
Félix Saparelli 2022-09-05 16:47:20 +12:00 committed by GitHub
parent 9b405fc03f
commit 4885cfbb88
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -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 <%= crate.name %>-<%= version.actual %>
$ 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 %>-v<%= version.actual %>
$ cargo publish -p <%= crate.name %>
```
<% } %>
**To trigger builds initially, close and then immediately re-open this PR once.**
<% if (pr.releaseNotes) { %>
---