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

docs: Update changelog for v2.0.0 #486

Merged
merged 9 commits into from
Aug 19, 2021
Merged

Conversation

clevinson
Copy link
Member

Description

Updates CHANGELOG.md for v2.0.0. A tag (v2.0.0-beta1) will be made off of this merge commit.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@codecov
Copy link

codecov bot commented Aug 19, 2021

Codecov Report

Merging #486 (7ad2ec4) into master (82baa5b) will not change coverage.
The diff coverage is n/a.

❗ Current head 7ad2ec4 differs from pull request most recent head 8c47c46. Consider uploading reports for the commit 8c47c46 to get more accurate results

@@           Coverage Diff           @@
##           master     #486   +/-   ##
=======================================
  Coverage   76.97%   76.97%           
=======================================
  Files         101      101           
  Lines       12531    12531           
=======================================
  Hits         9646     9646           
  Misses       2281     2281           
  Partials      604      604           
Flag Coverage Δ
experimental-codecov 76.97% <ø> (ø)
stable-codecov 61.07% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Copy link
Member

@ryanchristo ryanchristo left a comment

Choose a reason for hiding this comment

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

One typo, one formatting issue, and some observations. Pre-approving.

CHANGELOG.md Outdated Show resolved Hide resolved
Comment on lines +36 to +38
* [#385](https://github.com/regen-network/regen-ledger/pull/385) add support for credit cancelling
* [#425](https://github.com/regen-network/regen-ledger/pull/425) add params for an allowlist of permissioned credit designers
* [#451](https://github.com/regen-network/regen-ledger/pull/451) add queries to list classes and batches with a class
Copy link
Member

Choose a reason for hiding this comment

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

These three are issues rather than pull requests. I think it's ok to link the issue but I just thought I might point that out. You can use /issue/ or /pull/ and the links resolve either way.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah I think in general we should probably be sticking w/ PRs. Saw that some issues snuck in but I was a bit lazy to check them in detail. Let's try and keep practice of using PRs in changelog moving forward.

Comment on lines +45 to +50
* [#392](https://github.com/regen-network/regen-ledger/pull/392) update class ID and batch denomination formats
* [#328](https://github.com/regen-network/regen-ledger/pull/328) record retirement locations of ecocredit
* [#393](https://github.com/regen-network/regen-ledger/pull/393) add dates as top level fields in credit batches
* [#394](https://github.com/regen-network/regen-ledger/pull/394) add project location as field in credit batches
* [#435](https://github.com/regen-network/regen-ledger/pull/435) use dec wrapper for decimal operations
* [#424](https://github.com/regen-network/regen-ledger/pull/424) add credit types to credit class
Copy link
Member

Choose a reason for hiding this comment

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

Same as above. These are all issues but no changes required.

CHANGELOG.md Outdated
Comment on lines 16 to 18
* ([#482](https://github.com/regen-network/regen-ledger/pull/482),
[regen-network/cosmos-sdk#42](http://github.com/regen-network/cosmos-sdk/pull/42))
Add support for on-chain creation of Permanent Locked Accounts
Copy link
Member

Choose a reason for hiding this comment

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

This should be one line.

Suggested change
* ([#482](https://github.com/regen-network/regen-ledger/pull/482),
[regen-network/cosmos-sdk#42](http://github.com/regen-network/cosmos-sdk/pull/42))
Add support for on-chain creation of Permanent Locked Accounts
* ([#482](https://github.com/regen-network/regen-ledger/pull/482), [regen-network/cosmos-sdk#42](http://github.com/regen-network/cosmos-sdk/pull/42)) Add support for on-chain creation of Permanent Locked Accounts

Copy link
Member

Choose a reason for hiding this comment

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

Another option: might be nice to use one line and put the fork link at the end.

Suggested change
* ([#482](https://github.com/regen-network/regen-ledger/pull/482),
[regen-network/cosmos-sdk#42](http://github.com/regen-network/cosmos-sdk/pull/42))
Add support for on-chain creation of Permanent Locked Accounts
* [#482](https://github.com/regen-network/regen-ledger/pull/482) Add support for on-chain creation of Permanent Locked Accounts [regen-network/cosmos-sdk#42](http://github.com/regen-network/cosmos-sdk/pull/42)

Copy link
Member Author

Choose a reason for hiding this comment

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

These still render as a single line in the Markdown view. The multiline is only so that we keep line-width from being too long when viewing in an editor (so to make writing/editing of the changelog easier). I think I'd like to keep it as multiline, but like your suggestion of putting the fork PR at the end.

CHANGELOG.md Outdated
@@ -6,23 +6,56 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Features
## [v2.0.0-beta1](https://github.com/regen-network/regen-ledger/releases/tag/v2.0.0-beta1) - 2021-08-18
Copy link
Member

Choose a reason for hiding this comment

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

This will need to be updated if not merged tonight. ; )

CHANGELOG.md Outdated Show resolved Hide resolved
Copy link
Contributor

@anilcse anilcse left a comment

Choose a reason for hiding this comment

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

lgtm

@@ -6,23 +6,56 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Features
## [v2.0.0-beta1](https://github.com/regen-network/regen-ledger/releases/tag/v2.0.0-beta1) - 2021-08-19
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
## [v2.0.0-beta1](https://github.com/regen-network/regen-ledger/releases/tag/v2.0.0-beta1) - 2021-08-19
## [v2.0.0-beta1](https://github.com/regen-network/regen-ledger/releases/tag/v2.0.0-beta1) - 2021-08-20

CHANGELOG.md Outdated Show resolved Hide resolved
Co-authored-by: Anil Kumar Kammari <[email protected]>
@clevinson clevinson enabled auto-merge (squash) August 19, 2021 20:57
@clevinson clevinson merged commit b9c083f into master Aug 19, 2021
@clevinson clevinson deleted the clevinson/v2.0-beta-changelog branch August 19, 2021 20:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants