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 (backport #336) #338

Merged
merged 5 commits into from
May 8, 2024

Conversation

mergify[bot]
Copy link

@mergify mergify bot commented Mar 15, 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.

This is an automatic backport of pull request #336 done by [Mergify](https://mergify.com).

(cherry picked from commit c759d95)

# Conflicts:
#	CHANGELOG.md
#	RELEASE_CHANGELOG.md
#	RELEASE_NOTE.md
@mergify mergify bot added the conflicts label Mar 15, 2024
Copy link
Author

mergify bot commented Mar 15, 2024

Cherry-pick of c759d95 has failed:

On branch mergify/bp/release/v2.0.x/pr-336
Your branch is up to date with 'origin/release/v2.0.x'.

You are currently cherry-picking commit c759d95.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   .github/workflows/tag.yml
	new file:   RELEASE_DESCR.md
	new file:   scripts/release-note.py

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	both modified:   CHANGELOG.md
	deleted by them: RELEASE_CHANGELOG.md
	deleted by them: RELEASE_NOTE.md

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

170210
170210 previously approved these changes Mar 15, 2024
CHANGELOG.md Show resolved Hide resolved
RELEASE_DESCR.md Show resolved Hide resolved
@tkxkd0159 tkxkd0159 added ci github_actions Pull requests that update GitHub Actions code and removed conflicts labels Mar 25, 2024
@tkxkd0159 tkxkd0159 requested review from 170210 and zemyblue March 25, 2024 04:11
@tkxkd0159 tkxkd0159 self-assigned this Mar 25, 2024
CHANGELOG.md Outdated Show resolved Hide resolved
Co-authored-by: Youngtaek Yoon <[email protected]>
@tkxkd0159 tkxkd0159 requested a review from 0Tech April 4, 2024 03:22
0Tech
0Tech previously approved these changes Apr 4, 2024
CHANGELOG.md Outdated Show resolved Hide resolved
@tkxkd0159 tkxkd0159 self-requested a review May 8, 2024 17:15
@tkxkd0159 tkxkd0159 removed their request for review May 8, 2024 17:16
@tkxkd0159 tkxkd0159 removed their assignment May 8, 2024
@tkxkd0159 tkxkd0159 self-requested a review May 8, 2024 17:17
@tkxkd0159 tkxkd0159 merged commit f03706e into release/v2.0.x May 8, 2024
34 checks passed
@tkxkd0159 tkxkd0159 deleted the mergify/bp/release/v2.0.x/pr-336 branch May 8, 2024 17:17
@tkxkd0159 tkxkd0159 self-assigned this May 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci github_actions Pull requests that update GitHub Actions code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants