Skip to content

Commit

Permalink
Merge branch 'main' into feat/plugin-system-improvements-versioning
Browse files Browse the repository at this point in the history
  • Loading branch information
jeronimoalbi committed Oct 5, 2023
2 parents 813702f + 88ffe62 commit bb09bd0
Show file tree
Hide file tree
Showing 72 changed files with 1,057 additions and 457 deletions.
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# CODEOWNERS: https://help.github.com/articles/about-codeowners/

# Primary repo maintainers
* @ilgooz @jeronimoalbi @Pantani
* @ilgooz @jeronimoalbi @Pantani @julienrbrt @Ehsan-saradar

# Docs
*.md @ilgooz
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ scripts/**/nodetime-*
dist/
node_modules
.DS_Store
apps/
.idea
.vscode
docs/.vuepress/dist
Expand Down
4 changes: 4 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,11 @@
- [#3559](https://github.com/ignite/cli/pull/3559) Bump network plugin version to `v0.1.1`
- [#3522](https://github.com/ignite/cli/pull/3522) Remove indentation from `chain serve` output
- [#3601](https://github.com/ignite/cli/pull/3601) Update ts-relayer version to `0.10.0`
- [#3658](https://github.com/ignite/cli/pull/3658) Rename Marshaler to Codec in EncodingConfig
- [#3653](https://github.com/ignite/cli/pull/3653) Add "app" extension to plugin binaries
- [#3656](https://github.com/ignite/cli/pull/3656) Disable Go toolchain download
- [#3662](https://github.com/ignite/cli/pull/3662) Refactor CLI "plugin" command to "app"
- [#3669](https://github.com/ignite/cli/pull/3669) Rename `plugins` config file to `igniteapps`

### Fixes

Expand All @@ -30,6 +33,7 @@
- [#3610](https://github.com/ignite/cli/pull/3610) Fix overflow issue of cosmos faucet in `pkg/cosmosfaucet/transfer.go` and `pkg/cosmosfaucet/cosmosfaucet.go`
- [#3618](https://github.com/ignite/cli/pull/3618) Fix TS client generation import path issue
- [#3631](https://github.com/ignite/cli/pull/3631) Fix unnecessary vue import in hooks/composables template
- [#3661](https://github.com/ignite/cli/pull/3661) Change `pkg/cosmosanalysis` to find Cosmos SDK runtime app registered modules

## [`v0.27.0`](https://github.com/ignite/cli/releases/tag/v0.27.0)

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/02-guide/06-ibc.md
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ acknowledgment.
Append the type instance as `PostID` on receiving the packet:

- The context `ctx` is an [immutable data
structure](https://docs.cosmos.network/main/core/context.html#go-context-package)
structure](https://docs.cosmos.network/main/core/context#go-context-package)
that has header data from the transaction. See [how the context is
initiated](https://github.com/cosmos/cosmos-sdk/blob/main/types/context.go#L71)
- The identifier format that you defined earlier
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/02-guide/10-simapp.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ simulation methods for each scaffolded message.

Every new module that is scaffolded with Ignite CLI implements the Cosmos SDK
[Module
Simulation](https://docs.cosmos.network/main/building-modules/simulator.html).
Simulation](https://docs.cosmos.network/main/building-modules/simulator).

- Each new message creates a file with the simulation methods required for the
tests.
Expand Down Expand Up @@ -105,7 +105,7 @@ according to call the function.
## Invariants

Simulating a chain can help you prevent [chain invariants
errors](https://docs.cosmos.network/main/building-modules/invariants.html). An
errors](https://docs.cosmos.network/main/building-modules/invariants). An
invariant is a function called by the chain to check if something broke,
invalidating the chain data. To create a new invariant and check the chain
integrity, you must create a method to validate the invariants and register all
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/06-migration/v0.19.2.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ official Ignite CLI repo which introduces breaking changes.
To migrate your chain that was scaffolded with Ignite CLI versions lower than v0.19.2:

1. IBC upgrade: Use
the [IBC migration documents](https://github.com/cosmos/ibc-go/blob/main/docs/migrations/v1-to-v2.md)
the [IBC migration documents](https://github.com/cosmos/ibc-go/blob/v6.2.0/docs/migrations/v1-to-v2.md)

2. In your chain's `go.mod` file, remove `tendermint/spm` and add the v0.19.2 version of `tendermint/starport`. If your
chain uses these packages, change the import paths as shown:
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/06-migration/v0.26.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ their tooling to the latest version.

Chains that are newly scaffolded with Ignite CLI `v0.26.0` now use `ibc-go/v6` for ibc functionality. It is not
necessary, but recommended to upgrade to the newest version of `ibc-go`. Most migrations can be done by following the
`ibc-go` [migration guide](https://github.com/cosmos/ibc-go/blob/main/docs/migrations/v5-to-v6.md), but there are some
`ibc-go` [migration guide](https://github.com/cosmos/ibc-go/blob/v6.2.0/docs/migrations/v5-to-v6.md), but there are some
specific changes that will need to be followed for Ignite scaffolded chains.

### Removing `cosmosibckeeper`
Expand Down Expand Up @@ -215,7 +215,7 @@ func (k Keeper) Logger(ctx sdk.Context) log.Logger {

### Remaining migration

After all uses of `cosmosibckeeper` have been removed, you can follow any remaining steps in the`ibc-go`[migration guide](https://github.com/cosmos/ibc-go/blob/main/docs/migrations/v5-to-v6.md).
After all uses of `cosmosibckeeper` have been removed, you can follow any remaining steps in the`ibc-go`[migration guide](https://github.com/cosmos/ibc-go/blob/v6.2.0/docs/migrations/v5-to-v6.md).

## Scaffolded Release Workflow

Expand Down
17 changes: 17 additions & 0 deletions docs/docs/06-migration/v0.28.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
sidebar_position: 990
title: v0.28.0
description: For chains that were scaffolded with Ignite CLI versions lower than v0.28.0. changes are required to use Ignite CLI v0.28.0.
---

## Upgrading legacy plugins configuration files

Ignite `v0.28.0` changes the plugin system which is now called Ignite Apps. This version includes changes
to the CLI command names and the plugin configuration file.

The plugins configuration file is now called `igniteapps.yml` and the "plugins" section is now called "apps".

The global plugins directory is now `$HOME/.ignite/apps` instead `$HOME/.ignite/plugins`.

Updates can be automatically applied by running `ignite doctor` in your blockchain application directory.
Running the command outside your blockchain application directory will only update the global plugins.
42 changes: 42 additions & 0 deletions docs/docs/apps/01-using-apps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
description: Using and Developing Ignite Apps
---

# Using Ignite Apps

Apps offer a way to extend the functionality of the Ignite CLI. There are two
core concepts within apps: `Commands` and `Hooks`. `Commands` extend the CLI's
functionality and `Hooks` extend existing CLI command functionality.

Apps are registered in an Ignite scaffolded blockchain project through the
`igniteapps.yml`, or globally through `$HOME/.ignite/apps/igniteapps.yml`.

To use an app within your project execute the following command inside the
project directory:

```sh
ignite app install github.com/project/cli-app
```

The app will be available only when running `ignite` inside the project
directory.

To use an app globally on the other hand, execute the following command:

```sh
ignite app install -g github.com/project/cli-app
```

The command will compile the app and make it immediately available to the
`ignite` command lists.

## Listing installed apps

When in an ignite scaffolded blockchain you can use the command `ignite app
list` to list all Ignite Apps and there statuses.

## Updating apps

When an app in a remote repository releases updates, running `ignite app
update <path/to/app>` will update an specific app declared in your
project's `config.yml`.
Loading

0 comments on commit bb09bd0

Please sign in to comment.