Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

release: update release README.md and remove old scripts #1610

Merged
merged 2 commits into from
Aug 27, 2020

Conversation

Rjected
Copy link
Collaborator

@Rjected Rjected commented Jul 27, 2020

This should hopefully help document the steps to publish a release on the maintainer side of things, if there are any details left out or additional steps that should be documented, feedback is welcome!

Would like input from:
@jcvernaleo
@Roasbeef

Copy link
Member

@Roasbeef Roasbeef left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating this documentation!

@@ -6,11 +6,52 @@ binaries are now reproducible, allowing developers to build the binary on
distinct machines, and end up with a byte-for-byte identical binary. However,
this wasn't _fully_ solved in `go1.13`, as the build system still includes the
directory the binary is built into the binary itself. As a result, our scripts
utilize a work around needed until `go1.13.2`.
utilize a work around needed until `go1.13.2`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One other thing related to this, is that all the releases should note which Go version was used to build the release so people can properly reproduce the binaries if they wish.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should have resolved this, placed notes in both the section for maintainers and the description up top


Sign the `manifest-<TAG>.txt` file like so:
```sh
gpg --output manifest-<TAG>.txt.sig --sign manifest-<TAG>.txt
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I usually sign with a detached sig. This produces a smaller output (as the document itself isn't included in the signature). Based on your example above, signing with a detached sig would look something like:

gpg --sign --detach-sig manifest-<TAG>.txt

We can drop the --output, as it's automatically create the sig in a file name that adds .sig to the referenced file to be signed.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed to detached sig, should be good now

Copy link
Member

@jcvernaleo jcvernaleo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree with @Roasbeef's comments but after that looks good.

@Rjected Rjected force-pushed the release_docs branch 3 times, most recently from cf0eb8e to 6278f3e Compare August 6, 2020 02:16
Copy link
Collaborator

@onyb onyb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please add a small note about updating the CHANGES file?

- remove prep_release.sh and notes.sample
- update license in release.sh
- add notes for maintainers on the release process
- mention CHANGES file modifications
@Rjected
Copy link
Collaborator Author

Rjected commented Aug 12, 2020

Can you please add a small note about updating the CHANGES file?

Should be addressed, let me know what you think!

Copy link
Collaborator

@onyb onyb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great to me!

Copy link
Member

@jcvernaleo jcvernaleo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK

@jcvernaleo jcvernaleo merged commit 2a0d6fd into btcsuite:master Aug 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants