fort-nix / nix-bitcoin

A collection of Nix packages and NixOS modules for easily installing full-featured Bitcoin nodes with an emphasis on security.
https://nixbitcoin.org
MIT License
512 stars 108 forks source link

New Release Notification Doesn't Include Release Notes #726

Open OliverOffing opened 3 months ago

OliverOffing commented 3 months ago

For some reason, the notification I get from GitHub for new releases for nix-bitcoin doesn't include release notes.

Is there anything we can change in the release process to make them show up?

I understand this is a relatively small, lower priorty issue, but I'd greatly appreciate it.

image ![image](https://github.com/user-attachments/assets/65cbffbb-9ad0-43a1-9b55-6da2d4bf7418)
jonasnick commented 3 months ago

The reason this happens is probably that I create releases with our push-release.sh script which does not add release notes. To then add release notes, I use the github web interface to edit the release.

erikarvstedt commented 3 months ago

@jonasnick, I could amend the push-release.sh script to allow editing the release notes with EDITOR, like in git interactive rebase. This way, the release is created with the complete release notes. Would this fit your workflow?

Which script do you use to create the Change Log section of the release notes? We could integrate it into the release script.

jonasnick commented 3 months ago

Thanks @erikarvstedt, this would work. I don't have a script to create the Change Log section.

erikarvstedt commented 3 months ago

So you create the change log section manually?

jonasnick commented 3 months ago

I use this

#!/usr/bin/env bash
set -euo pipefail

REPO=fort-nix/nix-bitcoin

curl https://api.github.com/repos/$REPO/pulls?state=closed | jq '.[] | {closed_at,number,title,user: .user.login}' | jq -c -r '.closed_at + " #" + (.number|tostring) + " " + .title + " (@" + .user + ")"' | sort | awk -F' ' '{$1 = ""; print}'

but it just shows all PRs instead of the ones since the last release and it doesn't distinguish closed from merged PRs.