Automatically generates release note and binaries on release #126

torao · 2022-12-09T07:51:47Z

Description

This PR is to create a release note and release binaries and list them in the repository release automatically when a release tag is pushed.

Note that now make build is only run targeting linux/amd64 to create the default binary. The binaries for other platforms will be built in subsequent PRs.
For now, the Docker image for the build is not created in a public repository like hub.docker.com, but instead docker build is performed within GitHub Actions (it may only take a few minutes).

Motivation and context

According to #116, it would be nice if Github Actions could be triggered at release time to generate binaries for various platforms, rather than having to try out LBM, as is done in cosmos/gaia.

How to use

There are two steps that must be taken at release:

Rewrite the release note in ./RELEASE_NOTE.md. The contents of this file will be used to detail the release note.
```
# LBM v0.0.0 Release Notes
Write a description of release v0.0.0 here. Note the relative paths of the links.
```

Create a release tag and push it.

% git tag -a v0.1.2 -m '...'
% git push origin v0.1.2

This will then create a release note and release binaries, which will be listed in the repository release as Draft. Check the contents of the release and if there are no problems, publish it.

The available formal tag name formats are as follows:

v[0-9]+.[0-9]+.[0-9]+
v[0-9]+.[0-9]+.[0-9]+-rc[0-9]+

It's also possible to build release binaries locally by executing the following make command:

% cd builders/build-artifacts
% docker build -t lbm/build-artifacts .
% cd ../..
% make distclean build-reproducible

This will create the release binaries in the ./artifacts directory.

Internal Architecture

When the release tag is pushed and release-build.yml is invoked, (1) build docker image first, (2) run make build-reproducible to, and (3) upload the generated build_report and release binaries.

To add build targets: See the build-reproducible section of the Makefile. Also, if you have to do a special compilation for that target, add a conditional branch in .release-build.sh. In some cases, you may need to add apt get, etc. to builders/rbuilder/Dockerfile.
To change the format of the release note: You may modify the ./contrib/generate_release_note/main.go to create it.

How has this been tested?

I've confirmed that release notes and binaries are generated in my personal repository for working with GitHub Actions, and should be tested after it is merged into LBM's main branch.

Screenshots (if appropriate):

When this PR is merged, a tag like v0.0.0 will automatically create a release note like the following when pushed:

Checklist:

I followed the contributing guidelines.
I have updated the documentation accordingly.
I have added tests to cover my changes.

The push of release tag should automatically generate release notes and release builds.

zemyblue

Please add changelog
Please change the release note information to get from the RELEASE_NOTES.md like https://github.com/cosmos/cosmos-sdk/blob/v0.46.6/RELEASE_NOTES.md

.github/workflows/release-build.yml

zemyblue · 2022-12-12T06:48:22Z

.github/workflows/release-build.yml

+            asset_path: ./artifacts/lbm-${{ env.VERSION }}-linux-amd64
+            asset_name: lbm-${{ env.VERSION }}-linux-amd64
+            asset_content_type: application/binary
+#      -   name: "Upload linux-arm64 artifact"


Do you know why it failed in this case?

So far I’ve confirmed that linux/arm64 produces the following assembler-level error, but I haven’t yet investigated the reason for it.

Building for linux/arm64 CGO_CFLAGS= CGO_LDFLAGS= CGO_ENABLED=1 go build -mod=readonly -tags "netgo ledger... # runtime/cgo gcc_arm64.S: Assembler messages: gcc_arm64.S:28: Error: no such instruction: `stp x29,x30,[sp,' gcc_arm64.S:32: Error: too many memory references for `mov' gcc_arm64.S:34: Error: no such instruction: `stp x19,x20,[sp,' gcc_arm64.S:37: Error: no such instruction: `stp x21,x22,[sp,' ...

torao · 2022-12-13T10:14:51Z

@zemyblue

Please change the release note information to get from the RELEASE_NOTES.md like https://github.com/cosmos/cosmos-sdk/blob/v0.46.6/RELEASE_NOTES.md

Do you mean that it should generate the information to be displayed in the release from RELEASE_NOTE.md instead of CHANGELOG.md? If so, what's the specification and format of RELEASE_NOTE.md that you expected to use to extract the desired release information?

zemyblue · 2022-12-14T02:34:38Z

@zemyblue

Please change the release note information to get from the RELEASE_NOTES.md like https://github.com/cosmos/cosmos-sdk/blob/v0.46.6/RELEASE_NOTES.md

Do you mean that it should generate the information to be displayed in the release from RELEASE_NOTE.md instead of CHANGELOG.md? If so, what's the specification and format of RELEASE_NOTE.md that you expected to use to extract the desired release information?

I hope it will look like https://github.com/cosmos/cosmos-sdk/releases/tag/v0.46.0. How can we do it?

torao · 2022-12-14T07:20:45Z

@zemyblue

I hope it will look like https://github.com/cosmos/cosmos-sdk/releases/tag/v0.46.0. How can we do it?

Instead of parsing CHANGELOG.md and extracting the new release section as cosmossdk/gaia does, should I just use the contents itself of RELEASE_NOTE.md as the release details?

zemyblue · 2022-12-14T08:24:39Z

@zemyblue

I hope it will look like https://github.com/cosmos/cosmos-sdk/releases/tag/v0.46.0. How can we do it?

Instead of parsing CHANGELOG.md and extracting the new release section as cosmossdk/gaia does, should I just use the contents itself of RELEASE_NOTE.md as the release details?

Yes. How do you think about this?

torao · 2022-12-14T09:08:43Z

@zemyblue Understood. I think that's fine.

torao · 2022-12-15T13:39:03Z

@zemyblue

Tag format v0.0.0-rc0 is newly supported.
Changed to create a release note with the contents of RELEASE_NOTE.md.
The usage described in this PR has been modified to do so.

RELEASE_NOTE.md

zemyblue · 2022-12-16T00:56:03Z

.github/workflows/release-build.yml

+      - "v[0-9]+"
+      - "v[0-9]+.[0-9]+"


I don't think this case would exist according to our rules.

So only v0.0.0 and v0.0.0-rc0 formats?

…bm into feature/prepare_release_binaries

add the feature of automated release note creation

9f35685

The push of release tag should automatically generate release notes and release builds.

torao self-assigned this Dec 9, 2022

torao marked this pull request as ready for review December 9, 2022 11:39

torao requested a review from zemyblue December 9, 2022 11:39

zemyblue requested review from 0Tech, dudong2 and tkxkd0159 December 12, 2022 00:45

zemyblue reviewed Dec 12, 2022

View reviewed changes

torao added 2 commits December 15, 2022 21:11

fix the pattern of tags to action

7624080

change to create document for release notes from RELEASE_NOTE.md.

19b4853

torao changed the title ~~Automatic creation of release note and binaries~~ Automatically generates release note and binaries on release Dec 15, 2022

torao requested a review from zemyblue December 15, 2022 13:39

Merge branch 'main' into feature/prepare_release_binaries

c1f1061

zemyblue reviewed Dec 16, 2022

View reviewed changes

torao added 5 commits December 16, 2022 16:14

create Dockerfile due to unknown license

83098af

Merge branch 'feature/prepare_release_binaries' of github.com:torao/l…

23cf5ff

…bm into feature/prepare_release_binaries

remove buildlib.sh due to unknown license

e18e4bb

change to create release note with cat in github actions

618ebce

fix changelog

bead4a9

zemyblue approved these changes Dec 16, 2022

View reviewed changes

dudong2 approved these changes Dec 16, 2022

View reviewed changes

torao merged commit cd91714 into Finschia:main Jan 5, 2023

torao mentioned this pull request Jan 19, 2023

Add a release build for the linux/arm64, darwin/amd64, and darwin/arm64 platform #130

Merged

13 tasks

zemyblue mentioned this pull request Apr 25, 2023

Release finschia v1.0.0 #182

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Automatically generates release note and binaries on release #126

Automatically generates release note and binaries on release #126

torao commented Dec 9, 2022 •

edited

Loading

zemyblue left a comment

zemyblue Dec 12, 2022

torao Dec 13, 2022

torao commented Dec 13, 2022

zemyblue commented Dec 14, 2022

torao commented Dec 14, 2022

zemyblue commented Dec 14, 2022

torao commented Dec 14, 2022

torao commented Dec 15, 2022 •

edited

Loading

zemyblue Dec 16, 2022

torao Dec 16, 2022

zemyblue Dec 16, 2022

torao Dec 16, 2022

Automatically generates release note and binaries on release #126

Automatically generates release note and binaries on release #126

Conversation

torao commented Dec 9, 2022 • edited Loading

Description

Motivation and context

How to use

Internal Architecture

How has this been tested?

Screenshots (if appropriate):

Checklist:

zemyblue left a comment

Choose a reason for hiding this comment

zemyblue Dec 12, 2022

Choose a reason for hiding this comment

torao Dec 13, 2022

Choose a reason for hiding this comment

torao commented Dec 13, 2022

zemyblue commented Dec 14, 2022

torao commented Dec 14, 2022

zemyblue commented Dec 14, 2022

torao commented Dec 14, 2022

torao commented Dec 15, 2022 • edited Loading

zemyblue Dec 16, 2022

Choose a reason for hiding this comment

torao Dec 16, 2022

Choose a reason for hiding this comment

zemyblue Dec 16, 2022

Choose a reason for hiding this comment

torao Dec 16, 2022

Choose a reason for hiding this comment

torao commented Dec 9, 2022 •

edited

Loading

torao commented Dec 15, 2022 •

edited

Loading