Skip to content

Minor changelog fixes#2449

Merged
ebuchman merged 3 commits intodevelopfrom
bucky/changelog
Sep 20, 2018
Merged

Minor changelog fixes#2449
ebuchman merged 3 commits intodevelopfrom
bucky/changelog

Conversation

@ebuchman
Copy link
Contributor

We should do a better job of enforcing changelog standards, of course it should be documented how it works and how to think about it in the first place. Maybe I'll write an ADR for it.

Seems like we may have missed a bunch of stuff though, so we should catch up in preparation for v0.25. It's a relatively minor release, despite at least a few breaking changes.

- [mempool] [\#2399](https://github.com/tendermint/tendermint/issues/2399) Make mempool cache a proper LRU (@bradyjoestar)
- [types] add Address to GenesisValidator [\#1714](https://github.com/tendermint/tendermint/issues/1714)
- [types] [\#1714](https://github.com/tendermint/tendermint/issues/1714) Add Address to GenesisValidator
- [metrics] `consensus.block_interval_metrics` is now gauge, not histogram (you will be able to see spikes, if any)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

is this actually a breaking change? technically the metrics are an API exposed to other processes and hence need to be properly covered by SemVer unless we add an exemption in the readme

Copy link
Contributor

Choose a reason for hiding this comment

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

is this actually a breaking change?

don't think so. prometheus won't crash because metric's type got changed

Copy link
Contributor Author

Choose a reason for hiding this comment

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

will the code of any clients need to change ?

* [mempool] \#2310 Mempool tracks the `ResponseCheckTx.GasWanted` and enforces `ConsensusParams.BlockSize.MaxGas` on proposals.

* Go API
* \#2310 Mempool.ReapMaxBytes -> Mempool.ReapMaxBytesMaxGas
Copy link
Contributor

@ValarDragon ValarDragon Sep 19, 2018

Choose a reason for hiding this comment

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

Not sure why this was deleted? This is a breaking API change, as its changed the mempool interface. The new line in the Apps section does not note this API change.

Copy link
Contributor Author

@ebuchman ebuchman Sep 20, 2018

Choose a reason for hiding this comment

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

Fortunately for us maintainers, the mempool and state Go APIs are not covered by our SemVer, so we can break them as much as we want without worrying about the changelog or version bumps :). See https://github.com/tendermint/tendermint/#semver :

To provide some stability to Tendermint users in these 0.X.X days, the MINOR version is used to signal breaking changes across a subset of the total public API. This subset includes all interfaces exposed to other processes (cli, rpc, p2p, etc.), but does not include the in-process Go APIs.

@codecov-io
Copy link

Codecov Report

Merging #2449 into develop will increase coverage by 0.01%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           develop    #2449      +/-   ##
===========================================
+ Coverage    61.45%   61.46%   +0.01%     
===========================================
  Files          197      197              
  Lines        16342    16342              
===========================================
+ Hits         10043    10045       +2     
+ Misses        5465     5463       -2     
  Partials       834      834
Impacted Files Coverage Δ
p2p/pex/pex_reactor.go 74% <0%> (-0.34%) ⬇️
consensus/reactor.go 73.02% <0%> (-0.27%) ⬇️
consensus/state.go 77.03% <0%> (+0.23%) ⬆️
libs/clist/clist.go 68.02% <0%> (+1.52%) ⬆️

- [mempool] [\#2399](https://github.com/tendermint/tendermint/issues/2399) Make mempool cache a proper LRU (@bradyjoestar)
- [types] add Address to GenesisValidator [\#1714](https://github.com/tendermint/tendermint/issues/1714)
- [types] [\#1714](https://github.com/tendermint/tendermint/issues/1714) Add Address to GenesisValidator
- [metrics] `consensus.block_interval_metrics` is now gauge, not histogram (you will be able to see spikes, if any)
Copy link
Contributor

Choose a reason for hiding this comment

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

is this actually a breaking change?

don't think so. prometheus won't crash because metric's type got changed

@xla xla changed the title Bucky/changelog Guide to CHANGELOG and comsistency fix Sep 20, 2018
@xla xla added C:docs Component: Documentation T:enhancement Type: Enhancement labels Sep 20, 2018
@xla xla added this to the launch milestone Sep 20, 2018
@ebuchman ebuchman changed the title Guide to CHANGELOG and comsistency fix Minor changelog fixes Sep 20, 2018
@ebuchman ebuchman merged commit 7b727bf into develop Sep 20, 2018
@ebuchman ebuchman deleted the bucky/changelog branch September 20, 2018 15:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

C:docs Component: Documentation T:enhancement Type: Enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants