Skip to content

Commit

Permalink
chore: release v0.21.0 (#2464)
Browse files Browse the repository at this point in the history
chore: release v0.21.0
  • Loading branch information
ilgooz authored May 10, 2022
2 parents 5ab6fbc + 161dc1d commit 6009368
Show file tree
Hide file tree
Showing 187 changed files with 6,383 additions and 1,342 deletions.
14 changes: 14 additions & 0 deletions .firebaserc
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"projects": {
"default": "ignite-hq"
},
"targets": {
"ignite-hq": {
"hosting": {
"docs.ignite.com": [
"ignite-go-docs"
]
}
}
}
}
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
*.md @fadeev @ilgooz @barriebyron @ignite-hq/growth-ecodev

# Primary repo maintainers
* @fadeev @ilgooz @lubtd @Pantani @ivanovpetr
* @fadeev @ilgooz @lubtd @Pantani @ivanovpetr @jeronimoalbi
44 changes: 44 additions & 0 deletions .github/workflows/docs-deploy-preview.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Docs Deploy Preview

on:
pull_request:
paths:
- "docs/**"

jobs:
build_and_deploy:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v2

- name: Cache node_modules
uses: actions/cache@v2
with:
path: docs/node_modules
key: node_modules-${{ hashFiles('**/package-lock.json') }}

- name: Setup node
uses: actions/setup-node@v2
with:
node-version: 16.x
cache: npm
cache-dependency-path: docs/package-lock.json

- name: Install Dependencies
run: npm install
working-directory: ./docs

- name: Build
run: npm run build
working-directory: ./docs

- name: Deploy
uses: FirebaseExtended/action-hosting-deploy@v0
with:
repoToken: "${{ secrets.GITHUB_TOKEN }}"
firebaseServiceAccount: "${{ secrets.FIREBASE_SERVICE_ACCOUNT_IGNITE_HQ }}"
expires: 7d
target: docs.ignite.com
projectId: ignite-hq
44 changes: 44 additions & 0 deletions .github/workflows/docs-deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Docs Deploy

on:
push:
branches:
- develop

jobs:
build_and_deploy:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v2

- name: Cache node_modules
uses: actions/cache@v2
with:
path: docs/node_modules
key: node_modules-${{ hashFiles('**/package-lock.json') }}

- name: Setup node
uses: actions/setup-node@v2
with:
node-version: 16.x
cache: npm
cache-dependency-path: docs/package-lock.json

- name: Install Dependencies
run: npm install
working-directory: ./docs

- name: Build
run: npm run build
working-directory: ./docs

- name: Deploy
uses: FirebaseExtended/action-hosting-deploy@v0
with:
repoToken: "${{ secrets.GITHUB_TOKEN }}"
firebaseServiceAccount: "${{ secrets.FIREBASE_SERVICE_ACCOUNT_IGNITE_HQ }}"
channelId: live
target: docs.ignite.com
projectId: ignite-hq
9 changes: 9 additions & 0 deletions .gitpod.Dockerfile
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
FROM gitpod/workspace-full

# Go
ENV GO_VERSION=1.18.1
ENV GOPATH=$HOME/go-packages
ENV GOROOT=$HOME/go
ENV PATH=$GOROOT/bin:$GOPATH/bin:$PATH
RUN curl -fsSL https://dl.google.com/go/go${GO_VERSION}.linux-amd64.tar.gz | tar xzs && printf '%s\n' 'export GOPATH=/workspace/go' 'export PATH=$GOPATH/bin:$PATH' > $HOME/.bashrc.d/300-go

# GH CLI
RUN brew install gh

# NPM
RUN npm install -g [email protected]
8 changes: 7 additions & 1 deletion changelog.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
# Changelog

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

### Features

- Support simple app names when scaffolding chains. e.g.: `ignite scaffold chain mars`
- Ask confirmation when scaffolding over changes that are not committed yet

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

### Fixes

- Use `protoc` binary compiled in an older version of macOS AMD64 for backwards compatibility in code generation


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

### Fixes
Expand Down
2 changes: 1 addition & 1 deletion contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,6 @@ Ignite CLI follows Git Flow for branch strategy <https://www.atlassian.com/git/t

- A single project board <https://github.com/ignite-hq/cli/projects/4> shows the issues we are currently working on and what issues we plan to work on.

Contributors, please check the **To Do** column on the project board <https://github.com/tendermint/ignite-hq/cli/4> to find an issue to work on.
Contributors, check the **To Do** column on the project board <https://github.com/ignite-hq/cli/projects/4> to find an issue to work on. See the [Ignite CLI bounty program](docs/bounty/index.md) to learn how your participation can earn rewards.

We appreciate your contribution!
17 changes: 17 additions & 0 deletions docs/bounty/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
order: 1
description: Ignite CLI bounty program incentives and rewards.
parent:
order: 7
title: Bounty program
---

# Bounty program

Our Ignite CLI bounty program provides incentives for your participation and pays rewards. If you know Golang, follow the bounty issues, write code, close issues, and get rewarded.

Do your bounty hunting in our repo. Track new, in-progress, and completed bounties on the [Bounty board](https://github.com/ignite-hq/cli/projects/5) in GitHub.

For details on the Ignite CLI bounty program, join the #bounty channel in [Ignite Discord](https://discord.com/invite/ignite).

New bounties are posted and claimed in Discord on the #bounty announcement channel.
15 changes: 15 additions & 0 deletions docs/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -431,6 +431,7 @@ ignite generate dart [flags]

```
-h, --help help for dart
-y, --yes Answers interactive yes/no questions with yes
```

**Options inherited from parent commands**
Expand All @@ -456,6 +457,7 @@ ignite generate openapi [flags]

```
-h, --help help for openapi
-y, --yes Answers interactive yes/no questions with yes
```

**Options inherited from parent commands**
Expand All @@ -481,6 +483,7 @@ ignite generate proto-go [flags]

```
-h, --help help for proto-go
-y, --yes Answers interactive yes/no questions with yes
```

**Options inherited from parent commands**
Expand All @@ -507,6 +510,7 @@ ignite generate vuex [flags]
```
-h, --help help for vuex
--proto-all-modules Enables proto code generation for 3rd party modules used in your chain
-y, --yes Answers interactive yes/no questions with yes
```

**Options inherited from parent commands**
Expand Down Expand Up @@ -647,6 +651,7 @@ ignite scaffold band [queryName] --module [moduleName] [flags]
--module string IBC Module to add the packet into
-p, --path string path of the app (default ".")
--signer string Label for the message signer (default: creator)
-y, --yes Answers interactive yes/no questions with yes
```

**SEE ALSO**
Expand Down Expand Up @@ -693,6 +698,7 @@ ignite scaffold flutter [flags]
```
-h, --help help for flutter
-p, --path string path to scaffold content of the Flutter app (default "./flutter")
-y, --yes Answers interactive yes/no questions with yes
```

**SEE ALSO**
Expand All @@ -717,6 +723,7 @@ ignite scaffold list NAME [field]... [flags]
--no-simulation Disable CRUD simulation scaffolding
-p, --path string path of the app (default ".")
--signer string Label for the message signer (default: creator)
-y, --yes Answers interactive yes/no questions with yes
```

**SEE ALSO**
Expand All @@ -742,6 +749,7 @@ ignite scaffold map NAME [field]... [flags]
--no-simulation Disable CRUD simulation scaffolding
-p, --path string path of the app (default ".")
--signer string Label for the message signer (default: creator)
-y, --yes Answers interactive yes/no questions with yes
```

**SEE ALSO**
Expand All @@ -767,6 +775,7 @@ ignite scaffold message [name] [field1] [field2] ... [flags]
-p, --path string path of the app (default ".")
-r, --response strings Response fields
--signer string Label for the message signer (default: creator)
-y, --yes Answers interactive yes/no questions with yes
```

**SEE ALSO**
Expand Down Expand Up @@ -796,6 +805,7 @@ ignite scaffold module [name] [flags]
--params strings scaffold module params
-p, --path string path of the app (default ".")
--require-registration if true command will fail if module can't be registered
-y, --yes Answers interactive yes/no questions with yes
```

**SEE ALSO**
Expand Down Expand Up @@ -824,6 +834,7 @@ ignite scaffold packet [packetName] [field1] [field2] ... --module [moduleName]
--no-message Disable send message scaffolding
-p, --path string path of the app (default ".")
--signer string Label for the message signer (default: creator)
-y, --yes Answers interactive yes/no questions with yes
```

**SEE ALSO**
Expand All @@ -848,6 +859,7 @@ ignite scaffold query [name] [request_field1] [request_field2] ... [flags]
--paginated Define if the request can be paginated
-p, --path string path of the app (default ".")
-r, --response strings Response fields
-y, --yes Answers interactive yes/no questions with yes
```

**SEE ALSO**
Expand All @@ -872,6 +884,7 @@ ignite scaffold single NAME [field]... [flags]
--no-simulation Disable CRUD simulation scaffolding
-p, --path string path of the app (default ".")
--signer string Label for the message signer (default: creator)
-y, --yes Answers interactive yes/no questions with yes
```

**SEE ALSO**
Expand All @@ -896,6 +909,7 @@ ignite scaffold type NAME [field]... [flags]
--no-simulation Disable CRUD simulation scaffolding
-p, --path string path of the app (default ".")
--signer string Label for the message signer (default: creator)
-y, --yes Answers interactive yes/no questions with yes
```

**SEE ALSO**
Expand All @@ -916,6 +930,7 @@ ignite scaffold vue [flags]
```
-h, --help help for vue
-p, --path string path to scaffold content of the Vue.js app (default "./vue")
-y, --yes Answers interactive yes/no questions with yes
```

**SEE ALSO**
Expand Down
69 changes: 11 additions & 58 deletions docs/contributing/index.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
---
parent:
order: 6
title: Contributing to Ignite CLI docs
---

# Contributing to Ignite CLI docs

- [Contributing to Ignite CLI docs](#contributing-to-ignite-cli-docs)
- [Using this repo](#using-this-repo)
- [Reviewing technical content PRs](#reviewing-technical-content-prs)
- [Writing and contributing](#writing-and-contributing)
- [Where can I find the tutorials and docs?](#where-can-i-find-the-tutorials-and-docs)
- [Who works on the tutorials?](#who-works-on-the-tutorials)
- [Viewing tutorial builds](#viewing-tutorial-builds)
- [Preview PRs on a deployed preview](#preview-prs-on-a-deployed-preview)
- [Preview draft PRs on a local web browser](#preview-draft-prs-on-a-local-web-browser)

Thank you for visiting our repository and considering making contributions. We appreciate your interest in helping us to create and maintain awesome tutorials and documentation.

To set up your environment for success, follow the [technical setup](technical-setup.md) guidelines.
Expand All @@ -26,7 +22,7 @@ Review existing [Ignite CLI issues](https://github.com/ignite-hq/cli/issues) to

Some of the best content contributions come during the PR review cycles. Follow best practices for technical content PR reviews just like you do for code reviews.

- For in-line suggestions, use the [GitHub suggesting feature](https://docs.github.com/en/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).
- For in-line suggestions, use the [GitHub suggesting feature](https://docs.github.com/en/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request).
- The PR owner can merge in your suggested commits one at a time or in batch (preferred).
- When you are providing a more granular extensive review that results in more than 20 in-line suggestions, go ahead and check out the branch and make the changes yourself.

Expand Down Expand Up @@ -70,52 +66,9 @@ The Ignite product team developers are focused on building Ignite CLI and improv

Meet the [people behind Ignite CLI and our contributors](https://github.com/ignite-hq/cli/graphs/contributors).

## Viewing tutorial builds

There are two ways to see what your changes will look like in production before the updated pages are published.

- When a PR is ready for review, you can see a deployed preview on a URL that is unique for that PR.
- While a PR is in draft mode, you can preview a local build.

### Preview PRs on a deployed preview

After the PR moves from **Draft** to **Ready for review**, the CI status checks generate a CloudFlare deploy preview. This preview stays up to date as you continue to work and commit new changes to the same branch.

To view a deployed preview on a **Ready for review** PR, click the CloudFlare Pages **Preview URL** link.

### Preview draft PRs on a local web browser

Since the deploy preview doesn't work on Draft PRs, you can rely on using the preview in Markdown or for more complex content updates you can follow these steps to preview a tutorial and docs build on a local web browser.

1. If you haven't already, clone the tutorials repo to your local machine and change to that directory. For example:

```bash
cd ~/github
git clone https://github.com/ignite-hq/cli
cd ignite
cd docs
```

2. Local tutorials require JavaScript. If needed, install [npm](https://docs.npmjs.com/cli/v6/commands/npm-install).

3. For each branch you work in, install the npm packages for the tutorials:

```bash
npm install
```

4. Start the local instance of the tutorial build:

```bash
npm run serve
```

A successful client compile looks like:

```bash
> VuePress dev server listening at http://localhost:8080/ ✔ Client Compiled successfully in 280.71ms success [12:06:28] Build 03d41f finished in 283 ms! ( http://localhost:8080/ )
```
## Viewing docs builds

5. You can now view the docs build on a local web browser. Isn't this fun?
Use a preview to see what your changes will look like in production before the updated pages are published.

Tip: On a Mac, press the command key and click `http://localhost:8080/` in the terminal window for quick access to the local preview. If you are already using port 8080 on your local machine, the preview increments to the next available port 8081, and so on.
- While a PR is in draft mode, you can rely on using the preview feature in Markdown.
- After the PR moves from **Draft** to **Ready for review**, the CI status checks generate a deploy preview. This preview stays up to date as you continue to work and commit new changes to the same branch. A `Docs Deploy Preview / build_and_deploy (pull_request)` preview on a GitHub actions URL is unique for that PR.
Loading

0 comments on commit 6009368

Please sign in to comment.