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: revert middleware documentation and adds posthandler documentation #11988

Merged
merged 13 commits into from
May 27, 2022

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented May 18, 2022

Description

ref: #11955


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)

@julienrbrt julienrbrt marked this pull request as ready for review May 18, 2022 14:55
@julienrbrt julienrbrt requested a review from a team as a code owner May 18, 2022 14:55
@amaury1093 amaury1093 self-assigned this May 19, 2022
@julienrbrt
Copy link
Member Author

Should this PR includes the changes from #11985? cc @AmauryM

@amaury1093
Copy link
Contributor

Should this PR includes the changes from #11985? cc @AmauryM

Yes! docs should mention posthandlers. I'm fine to do it in a separate PR though

@julienrbrt
Copy link
Member Author

Okay, then I'll wait until we cut a new version, so I can as well update the references.

@julienrbrt julienrbrt marked this pull request as draft May 24, 2022 09:37
@amaury1093 amaury1093 added the backport/0.46.x PR scheduled for inclusion in the v0.46's next stable release label May 24, 2022
@julienrbrt julienrbrt changed the title docs: revert middleware documentation #11918 and #11445 docs: revert middleware documentation and adds posthandler documentation May 24, 2022
@julienrbrt julienrbrt marked this pull request as ready for review May 24, 2022 16:58
@julienrbrt julienrbrt added the A:automerge Automatically merge PR once all prerequisites pass. label May 26, 2022
@alexanderbez
Copy link
Contributor

What's the status of this PR?

@julienrbrt
Copy link
Member Author

What's the status of this PR?

Waiting for review :)

@codecov
Copy link

codecov bot commented May 27, 2022

Codecov Report

Merging #11988 (bbff9cb) into main (8eaff8f) will decrease coverage by 0.04%.
The diff coverage is n/a.

❗ Current head bbff9cb differs from pull request most recent head 73b101b. Consider uploading reports for the commit 73b101b to get more accurate results

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #11988      +/-   ##
==========================================
- Coverage   66.06%   66.02%   -0.05%     
==========================================
  Files         671      677       +6     
  Lines       70924    71341     +417     
==========================================
+ Hits        46856    47102     +246     
- Misses      21411    21552     +141     
- Partials     2657     2687      +30     
Impacted Files Coverage Δ
types/handler.go 100.00% <ø> (ø)
baseapp/test_helpers.go 59.32% <0.00%> (-14.88%) ⬇️
baseapp/baseapp.go 66.21% <0.00%> (-13.66%) ⬇️
x/params/module.go 57.77% <0.00%> (-8.89%) ⬇️
x/group/proposal.go 50.00% <0.00%> (-4.55%) ⬇️
server/mock/tx.go 60.00% <0.00%> (-3.16%) ⬇️
baseapp/options.go 65.97% <0.00%> (-2.54%) ⬇️
client/tx/legacy.go 60.97% <0.00%> (-1.53%) ⬇️
baseapp/abci.go 62.72% <0.00%> (-1.33%) ⬇️
simapp/app.go 82.25% <0.00%> (-1.23%) ⬇️
... and 175 more

@mergify mergify bot merged commit f5694bf into main May 27, 2022
@mergify mergify bot deleted the julien/revert-middleware-docs branch May 27, 2022 07:01
mergify bot pushed a commit that referenced this pull request May 27, 2022
…ion (#11988)

## Description

ref: #11955

- [x] Reverts the documentation updates about middlewares (#11918, #11445 and part of #11860).
- [x] Adds explanation about post-handlers
---

### 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...

- [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#pr-targeting))
- [x] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [x] reviewed "Files changed" and left comments if necessary
- [x] 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](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) 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)

(cherry picked from commit f5694bf)
tac0turtle pushed a commit that referenced this pull request May 27, 2022
…ion (#11988) (#12065)

## Description

ref: #11955

- [x] Reverts the documentation updates about middlewares (#11918, #11445 and part of #11860).
- [x] Adds explanation about post-handlers
---

### 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...

- [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#pr-targeting))
- [x] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [x] reviewed "Files changed" and left comments if necessary
- [x] 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](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) 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)

(cherry picked from commit f5694bf)

Co-authored-by: Julien Robert <julien@rbrt.fr>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:automerge Automatically merge PR once all prerequisites pass. backport/0.46.x PR scheduled for inclusion in the v0.46's next stable release C:x/auth C:x/authz C:x/feegrant C:x/group C:x/upgrade
Projects
No open projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants