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 docs links to v0.47 (backport #14572) #14591

Merged
merged 4 commits into from
Jan 12, 2023

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Jan 12, 2023

This is an automatic backport of pull request #14572 done by Mergify.
Cherry-pick of e4c0788 has failed:

On branch mergify/bp/release/v0.47.x/pr-14572
Your branch is up to date with 'origin/release/v0.47.x'.

You are currently cherry-picking commit e4c0788bf.
  (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:   UPGRADING.md
	modified:   api/cosmos/bank/v1beta1/authz.pulsar.go
	modified:   baseapp/baseapp.go
	modified:   core/appmodule/README.md
	modified:   depinject/README.md
	modified:   docs/docs/basics/00-app-anatomy.md
	modified:   docs/docs/basics/02-query-lifecycle.md
	modified:   docs/docs/basics/03-accounts.md
	modified:   docs/docs/basics/04-gas-fees.md
	modified:   docs/docs/building-apps/00-app-go.md
	modified:   docs/docs/building-apps/01-app-go-v2.md
	modified:   docs/docs/building-apps/02-app-mempool.md
	modified:   docs/docs/building-modules/01-module-manager.md
	modified:   docs/docs/building-modules/02-messages-and-queries.md
	modified:   docs/docs/building-modules/03-msg-services.md
	modified:   docs/docs/building-modules/04-query-services.md
	modified:   docs/docs/building-modules/05-beginblock-endblock.md
	modified:   docs/docs/building-modules/06-keeper.md
	modified:   docs/docs/building-modules/07-invariants.md
	modified:   docs/docs/building-modules/08-genesis.md
	modified:   docs/docs/building-modules/09-module-interfaces.md
	modified:   docs/docs/building-modules/11-errors.md
	modified:   docs/docs/building-modules/12-upgrade.md
	modified:   docs/docs/building-modules/13-simulator.md
	modified:   docs/docs/building-modules/14-depinject.md
	modified:   docs/docs/building-modules/15-testing.md
	modified:   docs/docs/core/00-baseapp.md
	modified:   docs/docs/core/01-transactions.md
	modified:   docs/docs/core/02-context.md
	modified:   docs/docs/core/03-node.md
	modified:   docs/docs/core/04-store.md
	modified:   docs/docs/core/06-grpc_rest.md
	modified:   docs/docs/core/07-cli.md
	modified:   docs/docs/core/08-events.md
	modified:   docs/docs/core/09-telemetry.md
	modified:   docs/docs/core/10-ocap.md
	modified:   docs/docs/core/11-runtx_middleware.md
	modified:   docs/docs/core/12-simulation.md
	modified:   docs/docs/core/13-proto-docs.md
	modified:   docs/docs/core/14-tips.md
	modified:   docs/docs/intro/03-sdk-design.md
	modified:   docs/docs/migrations/00-intro.md
	modified:   docs/docs/run-node/01-run-node.md
	modified:   docs/docs/run-node/03-txs.md
	modified:   docs/docs/tooling/00-protobuf.md
	modified:   proto/README.md
	modified:   proto/cosmos/bank/v1beta1/authz.proto
	modified:   proto/cosmos/base/snapshots/v1beta1/snapshot.proto
	modified:   simapp/app.go
	modified:   tools/cosmovisor/README.md
	modified:   x/auth/tx/README.md
	modified:   x/auth/vesting/README.md
	modified:   x/authz/README.md
	modified:   x/authz/keeper/msg_server_test.go
	modified:   x/bank/README.md
	modified:   x/bank/types/authz.pb.go
	modified:   x/bank/types/send_authorization_test.go
	modified:   x/crisis/README.md
	modified:   x/distribution/README.md
	modified:   x/evidence/README.md
	modified:   x/feegrant/README.md
	modified:   x/gov/README.md
	modified:   x/group/README.md
	modified:   x/group/internal/orm/README.md
	modified:   x/mint/README.md
	modified:   x/slashing/README.md
	modified:   x/staking/README.md
	modified:   x/upgrade/README.md

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	both modified:   api/cosmos/base/snapshots/v1beta1/snapshot.pulsar.go
	both modified:   docs/architecture/adr-050-sign-mode-textual-annex1.md
	both modified:   docs/architecture/adr-050-sign-mode-textual.md
	both modified:   docs/docs/core/05-encoding.md
	both modified:   snapshots/types/snapshot.pb.go
	deleted by us:   x/circuit/README.md

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


Mergify commands and options

More conditions and actions can be found in the documentation.

You can also trigger Mergify actions by commenting on this pull request:

  • @Mergifyio refresh will re-evaluate the rules
  • @Mergifyio rebase will rebase this PR on its base branch
  • @Mergifyio update will merge the base branch into this PR
  • @Mergifyio backport <destination> will backport this PR on <destination> branch

Additionally, on Mergify dashboard you can:

  • look at your merge queues
  • generate the Mergify configuration with the config editor.

Finally, you can contact us on https://mergify.com

(cherry picked from commit e4c0788)

# Conflicts:
#	api/cosmos/base/snapshots/v1beta1/snapshot.pulsar.go
#	docs/architecture/adr-050-sign-mode-textual-annex1.md
#	docs/architecture/adr-050-sign-mode-textual.md
#	docs/docs/core/05-encoding.md
#	snapshots/types/snapshot.pb.go
#	x/circuit/README.md
@@ -66,19 +64,4 @@ message SnapshotExtensionMeta {
// Since: cosmos-sdk 0.46
message SnapshotExtensionPayload {
bytes payload = 1;
}

// SnapshotKVItem is an exported Key/Value Pair
Copy link
Member

Choose a reason for hiding this comment

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

@AmauryM, given that is not used anywhere (as store/v2 is gone), is that okay to backport that deletion too? It is theoretically proto breaking, but because it was never used, this is okay to backport right?

Copy link
Contributor

Choose a reason for hiding this comment

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

but because it was never used

We did release 0.46 with this proto message, right? In this case I think we need to keep it unfortunately (also on main too)

Copy link
Member

Choose a reason for hiding this comment

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

Ah! :( We did release it indeed, but it was only used in store/v2alpha1, which had no users and has been deleted in v0.47.
Should we deprecate it with a comment that says it is not being used anywhere?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, that's what we did for other unused fields: add a comment and the proto deprecated=true annotation

Copy link
Member

Choose a reason for hiding this comment

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

Ok! I thought it only mattered for fields that were actually used. I will update then, thanks!

Copy link
Member

Choose a reason for hiding this comment

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

id just delete it tbh. it snot used by anything and if anyone is using it then they are using an internal api externally

Copy link
Contributor

Choose a reason for hiding this comment

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

The problem is that once it's exposed in proto files, then it's really not an internal API anymore, and even JS clients can consume them.

Seems to me that there's a risk of breaking backwards-compatibility if we remove, whereas the alternative of deprecation is safe and easy.

Copy link
Member

Choose a reason for hiding this comment

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

sure, but if anyone is using this then they are doing something wrong so I still think deleting is simpler than legacy/dead code sitting around

Copy link
Member

Choose a reason for hiding this comment

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

Merging this, and let's reach consensus here: #14597 (as it needs to be re-added on main anyway, if we keep it)

@julienrbrt julienrbrt removed their assignment Jan 12, 2023
@julienrbrt
Copy link
Member

After merge, we need to trigger the docs deployment action from main (https://github.com/cosmos/cosmos-sdk/actions/workflows/deploy-docs.yml) so it takes updates /v0.47 of the docs too.

@julienrbrt julienrbrt force-pushed the mergify/bp/release/v0.47.x/pr-14572 branch from 7373c11 to ca01b09 Compare January 12, 2023 12:52
@julienrbrt julienrbrt merged commit 9186a1e into release/v0.47.x Jan 12, 2023
@julienrbrt julienrbrt deleted the mergify/bp/release/v0.47.x/pr-14572 branch January 12, 2023 14:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants