Skip to content

Commit

Permalink
Add important usage note for triggering builds to release template (r…
Browse files Browse the repository at this point in the history
  • Loading branch information
passcod committed Sep 5, 2022
1 parent 9b405fc commit 4885cfb
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions .github/scripts/release-pr-template.ejs
Original file line number Diff line number Diff line change
Expand Up @@ -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) { %>
---
Expand Down

0 comments on commit 4885cfb

Please sign in to comment.