Skip to content

Commit

Permalink
Merge branch 'main' into feat/improve-buf-rate
Browse files Browse the repository at this point in the history
  • Loading branch information
Pantani committed May 16, 2024
2 parents bd94345 + 82316ac commit c72bbcb
Show file tree
Hide file tree
Showing 3 changed files with 74 additions and 12 deletions.
11 changes: 5 additions & 6 deletions docs/docs/02-guide/03-hello-world.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,24 +56,23 @@ import (
"context"
"fmt"

"hello/x/hello/types"

sdk "github.com/cosmos/cosmos-sdk/types"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"

"hello/x/hello/types"
)

func (k Keeper) SayHello(goCtx context.Context, req *types.QuerySayHelloRequest) (*types.QuerySayHelloResponse, error) {
func (q queryServer) SayHello(ctx context.Context, req *types.QuerySayHelloRequest) (*types.QuerySayHelloResponse, error) {
if req == nil {
return nil, status.Error(codes.InvalidArgument, "invalid request")
}

// Validation and Context unwrapping
ctx := sdk.UnwrapSDKContext(goCtx)
sdkCtx := sdk.UnwrapSDKContext(ctx)

_ = ctx
_ = sdkCtx
// Custom Response
// highlight-next-line
return &types.QuerySayHelloResponse{Name: fmt.Sprintf("Hello %s!", req.Name)}, nil
}
```
Expand Down
11 changes: 5 additions & 6 deletions docs/versioned_docs/version-v28/02-guide/03-hello-world.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,24 +56,23 @@ import (
"context"
"fmt"

"hello/x/hello/types"

sdk "github.com/cosmos/cosmos-sdk/types"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"

"hello/x/hello/types"
)

func (k Keeper) SayHello(goCtx context.Context, req *types.QuerySayHelloRequest) (*types.QuerySayHelloResponse, error) {
func (q queryServer) SayHello(ctx context.Context, req *types.QuerySayHelloRequest) (*types.QuerySayHelloResponse, error) {
if req == nil {
return nil, status.Error(codes.InvalidArgument, "invalid request")
}

// Validation and Context unwrapping
ctx := sdk.UnwrapSDKContext(goCtx)
sdkCtx := sdk.UnwrapSDKContext(ctx)

_ = ctx
_ = sdkCtx
// Custom Response
// highlight-next-line
return &types.QuerySayHelloResponse{Name: fmt.Sprintf("Hello %s!", req.Name)}, nil
}
```
Expand Down
64 changes: 64 additions & 0 deletions ignite/internal/tools/gen-mig-diffs/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
<div align="center">
<h1> Generate Ignite Migration Diffs </h1>
</div>

This repository hosts the Chain Scaffold Migration Tool for Ignite CLI, designed to help developers migrate their
projects from older versions of Ignite to the latest release.
This tool addresses compatibility and feature alignment as a detailed
in [Issue #3699](https://github.com/ignite/cli/issues/3699) and implemented
in [PR #3718](https://github.com/ignite/cli/pull/3718).

The migration tool aims to streamline the update process for projects built with Ignite CLI, ensuring they leverage the
latest improvements and SDK stack.

#### Features

- Automated migration of chain scaffold files.
- Detailed comparison and generation of migration differences.
- Support for multiple versions of chain scaffolds.

## Installation

It is located in the `ignite/internal/tools/gen-mig-diffs`
directory and made it a standalone project.

To set up this tool in your development environment:

1. Clone the Ignite CLI repository:

```shell
git clone https://github.com/ignite/cli.git && \
cd cli/ignite/internal/tools/gen-mig-diffs
```

2. Install and show usage:

```shell
go install . && gen-mig-diffs -h
```

3. Run migration diff tool:

```shell
gen-mig-diffs --output temp/migs --from v0.27.2 --to v28.3.0
```

## Usage

```bash
This tool is used to generate migration diff files for each of ignites scaffold commands

Usage:
gen-mig-diffs [flags]

Flags:
-f, --from string Version of Ignite or path to Ignite source code to generate the diff from
-h, --help help for gen-mig-diffs
-o, --output string Output directory to save the migration document (default "docs/docs/06-migration")
--repo-output string Output path to clone the Ignite repository
-s, --repo-source string Path to Ignite source code repository. Set the source automatically set the cleanup to false
--repo-url string Git URL for the Ignite repository (default "https://github.com/ignite/cli.git")
--scaffold-cache string Path to cache directory
--scaffold-output string Output path to clone the Ignite repository
-t, --to string Version of Ignite or path to Ignite source code to generate the diff to
```

0 comments on commit c72bbcb

Please sign in to comment.