add ability to mark Gitea/GitHub release as draft

[MarcoIeni]

Motivations

This feature is useful if you want to update other artifacts to the release later and you want to publish the release after the update was successful. Also if you want to review the release and publish it manually afterwards.

Solution

The config field already exists:

release-plz/crates/release_plz/src/config.rs

Line 314 in 88894d4

pub draft: Option<bool>,

but it's not used. Use it here:

release-plz/crates/release_plz_core/src/git/backend.rs

Line 181 in 88894d4

pub async fn create_github_release(&self, tag: &str, body: &str) -> anyhow::Result<()> {

The GitHub api call is documented here. As you can see you need to add a draft field in the body. This change should also work for Gitea. 👍

• also document this field in the docs. Specify that GitLab doesn't support it

[jdidion]

+1

This is essential if you want to use in conjunction with cargo-dist for adding binaries to releases and publishing afterwards.

[MarcoIeni]

Since it's a really easy issue, I hoped somebody else could pick this. If that's not the case, I'll try to implement this soon :)

[MarcoIeni]

Hey John, I have implemented this feature, and I will release the new release-plz version now.
If you manage to use release-plz with cargo-dist can you link me the repository?
I would like to document how the two can work together.
Also, let me know if you are interested in documenting your approach in https://release-plz.ieni.dev/docs/extra :)

[jdidion]

Thank you!