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

ci: add changelog reminder #15459

Merged
merged 11 commits into from
Mar 21, 2023
Prev Previous commit
Next Next commit
updates
  • Loading branch information
julienrbrt committed Mar 20, 2023
commit 2ea3e4bcf112eece8000077a08e3d9bfad5588ce
2 changes: 1 addition & 1 deletion cliff.toml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Ref: https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.j
# template for the changelog body
body = """
{% if version %}\
## [{{ version | trim_start_matches(pat="v") }}](https://github.com/cosmos/cosmos-sdk/releases/tag/{{version}}) - {{ timestamp | date(format="%Y-%m-%d") }}
## [{{ version }}](https://github.com/cosmos/cosmos-sdk/releases/tag/{{version}}) - {{ timestamp | date(format="%Y-%m-%d") }}
{% else %}\
## [Unreleased]
{% endif %}\
Expand Down
75 changes: 58 additions & 17 deletions math/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,28 +11,69 @@ Mention whether you follow Semantic Versioning.

Usage:

Change log entries are to be added to the Unreleased section under the
appropriate stanza (see below). Each entry should ideally include a tag and
the Github issue reference in the following format:
Changelog entries are generated by git cliff ref: https://github.com/orhun/git-cliff

* (<tag>) [#<issue-number>] Changelog message.
Each commit should be conventional, the following message groups are supported.

Types of changes (Stanzas):
* feat: A new feature
* fix: A bug fix
* docs: Documentation only changes
* style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
* refactor: A code change that neither fixes a bug nor adds a feature
* perf: A code change that improves performance
* test: Adding missing tests or correcting existing tests
* build: Changes that affect the build system or external dependencies (example scopes: go, npm)
* ci: Changes to our CI configuration files and scripts (example scopes: GH Actions)
* chore: Other changes that don't modify src or test files
* revert: Reverts a previous commit

"Features" for new features.
"Improvements" for changes in existing functionality.
"Deprecated" for soon-to-be removed features.
"Bug Fixes" for any bug fixes.
"API Breaking" for breaking exported APIs used by developers building on SDK.
Ref: https://keepachangelog.com/en/1.0.0/
When a change is made that affects the API or state machine, the commit message prefix should be suffixed with `!`.

Ref: https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json
-->

# Changelog

## [Unreleased]
## [math/v1.0.0-rc.0](https://github.com/cosmos/cosmos-sdk/releases/tag/math/v1.0.0-rc.0) - 2023-03-13

### Features

* Add rand funcs to math ([#15043](https://github.com/cosmos/cosmos-sdk/issues/15043))
Copy link
Member

Choose a reason for hiding this comment

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

this is inverting the format, if we go with this we should update the docs.

Copy link
Member Author

Choose a reason for hiding this comment

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

As this is a generated changelog, it is not supposed to be manually edited, so I think it's fine.
There are a few improvements to be made as discussed with @chatton, I've only added the git cliff to help us when tagging, to quickly verify whether the changelog is ok or not.

Copy link
Member

@tac0turtle tac0turtle Mar 20, 2023

Choose a reason for hiding this comment

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

its confusing that we have one way here and another elsewhere. Any chance we can decide on one or the other and go with it?

trying to make it consistent

Copy link
Member Author

Choose a reason for hiding this comment

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

This make sense, lmc how I can update the template!

Copy link
Member Author

Choose a reason for hiding this comment

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

Updated


### Bug Fixes

* Check for negative precision ([#14922](https://github.com/cosmos/cosmos-sdk/issues/14922))

### Testing

* Fix `FormatDec` test ([#15215](https://github.com/cosmos/cosmos-sdk/issues/15215))

## [math/v1.0.0-beta.6](https://github.com/cosmos/cosmos-sdk/releases/tag/math/v1.0.0-beta.6) - 2023-02-06

### Features

* Add collections key encoders and value encoders for common types. ([#14760](https://github.com/cosmos/cosmos-sdk/issues/14760))
* Math: add generics versions of Max, Min to cater to all numeric types ([#14166](https://github.com/cosmos/cosmos-sdk/issues/14166))
* Add uint `IsNil` method ([#13381](https://github.com/cosmos/cosmos-sdk/issues/13381))

### Improvements

* Math: optimize and test FormatInt + simplify LegacyNewDecFromStr ([#14010](https://github.com/cosmos/cosmos-sdk/issues/14010))
* Math: precompute & use square of precisionReuse instead of 2 repeated computations ([#12794](https://github.com/cosmos/cosmos-sdk/issues/12794))

### Bug Fixes

* Do not flatten events attributes by event types ([#14691](https://github.com/cosmos/cosmos-sdk/issues/14691))
* Math: add LegacyNewDecFromStr fuzzers + remove unnecessary error wrapping ([#14252](https://github.com/cosmos/cosmos-sdk/issues/14252))

### Testing

* Added test cases for precisionMultiplier ([#14576](https://github.com/cosmos/cosmos-sdk/issues/14576))

## [math/v1.0.0-beta.3](https://github.com/cosmos/cosmos-sdk/releases/tag/math/v1.0.0-beta.3) - 2022-07-20

### Bug Fixes

* Math: fix Uint.Unmarshal's lack of negative value checking ([#11996](https://github.com/cosmos/cosmos-sdk/issues/11996))

* [#14010](https://github.com/cosmos/cosmos-sdk/pull/14010) Optimize FormatInt to not do plain string concentation when formatting thousands and instead build it more efficiently.
* [#13381](https://github.com/cosmos/cosmos-sdk/pull/13381) Add uint `IsNil` method.
* [#12634](https://github.com/cosmos/cosmos-sdk/pull/12634) Move `sdk.Dec` to math package, call it `LegacyDec`.
* [#14166](https://github.com/cosmos/cosmos-sdk/pull/14166) Add generics versions of Max and Min, catering to all numeric types and allow for variadic calls, replacing the prior typed and strenuous code
* [#15043](https://github.com/cosmos/cosmos-sdk/pull/15043) Add rand functions for testing purposes
<!-- generated by git-cliff -->