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

add RELEASE_NOTE generation script #336

Merged
merged 10 commits into from
Mar 15, 2024
Merged

add RELEASE_NOTE generation script #336

merged 10 commits into from
Mar 15, 2024

Conversation

tkxkd0159
Copy link
Member

@tkxkd0159 tkxkd0159 commented Mar 6, 2024

Description

closes: #XXXX

  • Generate RELEASE_NOTE by code
  • Make what's changed only for regular release, not for release candidates. Because people mostly want to know the difference between main release. If we deploy the rc release notes separately, It's hard to track the changes at once.
  • Remove RELEASE_CHANGELOG. Use CHANGELOG instead.

Motivation and context

How has this been tested?

Sample output

# Finschia v3.0.0 Release Note

## Highlights
* patch [CWA-2023-004 issue](https://forum.cosmos.network/t/high-severity-security-patch-upcoming-on-wed-10th-cwa-2023-004-brought-to-you-by-certik-and-confio/12840)
* Ensure smart contracts compiled with Rust v1.70 run without errors.
* disable custom querier in wasm

## What's Changed
Check out all the changes [here](https://github.com/Finschia/finschia/compare/v2.0.2...v3.0.0)

### Features
* (build) [\#329](https://github.com/Finschia/finschia/pull/329) rename namespace to v3

### Improvements
* (improvements) [\#230](https://github.com/Finschia/finschia/pull/230) fix Makefile for format and execute make format #230
* (chore) [\#299](https://github.com/Finschia/finschia/pull/299) remove x/token and x/collection apis in swagger

### Bug Fixes
* (finschia-sdk) [\#297](https://github.com/Finschia/finschia/pull/297) bump up finschia-sdk from v0.48.0 to v0.48.1
* (ostracon) [\#333](https://github.com/Finschia/finschia/pull/333) bump up ostracon from v1.1.2 to v1.1.3

### Breaking Changes
* (wasmd) [\#328](https://github.com/Finschia/finschia/pull/328) bump up wasmd from v0.2.0 to v0.3.0

### Build, CI
* (ci) [\#290](https://github.com/Finschia/finschia/pull/290) remove autopr ci
* (ci) [\#291](https://github.com/Finschia/finschia/pull/291) fix goreleaser ci error and replace release-build
* (repo) [\#295](https://github.com/Finschia/finschia/pull/295) setup CODEOWNERS and backport action
* (ci) [\#296](https://github.com/Finschia/finschia/pull/296) bump actions/checkout from 3 to 4
* (ci) [\#305](https://github.com/Finschia/finschia/pull/305) add e2e-ibc ci
* (build) [\#316](https://github.com/Finschia/finschia/pull/316) change docker image version to fix build error

## Base sub modules
* Ostracon: [v1.1.3](https://github.com/Finschia/ostracon/tree/v1.1.3)
* Finschia-sdk: [v0.48.1](https://github.com/Finschia/finschia-sdk/tree/v0.48.1)
* Finschia/wasmd: [v0.3.0](https://github.com/Finschia/wasmd/tree/v0.3.0)
* Finschia/ibc-go: [v4.3.1](https://github.com/Finschia/ibc-go/tree/v4.3.1)

## Build from source
You must use Go 1.20 if building from source
\```shell
git clone https://github.com/Finschia/finschia
cd finschia && git checkout v3.0.0
make install
\```

## Run with Docker
If you want to run fnsad in a Docker container, you can use the Docker images.
* docker image: `finschia/finschianode:3.0.0`
\```shell
docker run finschia/finschianode:3.0.0 fnsad version
# 3.0.0
\```

## Download binaries

Binaries for linux and darwin are available below.

Screenshots (if appropriate):

Checklist:

  • I followed the contributing guidelines and code of conduct.
  • I have added a relevant changelog to CHANGELOG.md
  • I have added tests to cover my changes.
  • I have updated the documentation accordingly.

@tkxkd0159 tkxkd0159 self-assigned this Mar 6, 2024
@tkxkd0159 tkxkd0159 requested a review from a team March 6, 2024 09:46
Copy link
Member

@zemyblue zemyblue left a comment

Choose a reason for hiding this comment

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

Since this release note is also used as the URL for a software update proposal, it should be written in a language that regular Holders, not developers, can understand.

I think it would be good to use it as a script to create a basic release note that can be processed. In the case of a very simple minor update, it may be possible to use it without change.

However, it seems that in order to edit RELEASE_NOTE.md, it had to be modified in a separate PR. Is this possible by editing tag.yml? I don't want it to be automatically recorded as a release note when a tag is added. Is there a way?

@tkxkd0159
Copy link
Member Author

However, it seems that in order to edit RELEASE_NOTE.md, it had to be modified in a separate PR. Is this possible by editing tag.yml? I don't want it to be automatically recorded as a release note when a tag is added. Is there a way?

This Github release note will be generated when we push the tag. We have to take responsibility to maintain our RELEASE_CHANGELOG well and shouldn't push the tag if it's not done yet. And RELEASE_NOTE will be used as template file from this PR. We should fix the content directly in Github if we need it.

@tkxkd0159 tkxkd0159 added ci documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Mar 6, 2024
RELEASE_CHANGELOG.md Show resolved Hide resolved
RELEASE_CHANGELOG.md Show resolved Hide resolved
@tkxkd0159 tkxkd0159 requested a review from zemyblue March 10, 2024 04:04
CHANGELOG.md Outdated Show resolved Hide resolved
.github/workflows/tag.yml Outdated Show resolved Hide resolved
@tkxkd0159 tkxkd0159 requested a review from zemyblue March 12, 2024 03:16
@tkxkd0159 tkxkd0159 mentioned this pull request Mar 12, 2024
4 tasks
@tkxkd0159 tkxkd0159 requested review from ulbqb and 170210 March 14, 2024 01:48
@tkxkd0159 tkxkd0159 merged commit c759d95 into main Mar 15, 2024
37 checks passed
@tkxkd0159 tkxkd0159 deleted the script-release-note branch March 15, 2024 02:51
mergify bot pushed a commit that referenced this pull request Mar 15, 2024
(cherry picked from commit c759d95)

# Conflicts:
#	CHANGELOG.md
#	RELEASE_CHANGELOG.md
#	RELEASE_NOTE.md
mergify bot pushed a commit that referenced this pull request Mar 15, 2024
tkxkd0159 added a commit that referenced this pull request Apr 4, 2024
(cherry picked from commit c759d95)

Co-authored-by: Jayden Lee <41176085+tkxkd0159@users.noreply.github.com>
tkxkd0159 added a commit that referenced this pull request May 8, 2024
Co-authored-by: Jayden Lee <41176085+tkxkd0159@users.noreply.github.com>
Co-authored-by: Youngtaek Yoon <noreply@yoon.anonaddy.me>
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.

3 participants