Skip to content

Commit

Permalink
ci: markdownlint and diff fixes (#389)
Browse files Browse the repository at this point in the history
* ci: markdownlint

* forum

* lint

* lint 2

* lint

* fix diff

* update

* fix invalid input
  • Loading branch information
ranupthestairs committed Mar 14, 2022
1 parent 4dde2ed commit c573337
Show file tree
Hide file tree
Showing 31 changed files with 98 additions and 104 deletions.
10 changes: 5 additions & 5 deletions .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ jobs:
persist-credentials: false
fetch-depth: 0
- uses: technote-space/[email protected]
id: git_diff
with:
PATTERNS: |
docs/*
SUFFIX_FILTER: |
.md
docs/**/*.md
x/**/*.md
- name: Install dependencies and build docs 🧱
run: |
make build-docs
make build-docs
# Check only if there are differences in the source code
if: env.GIT_DIFF
10 changes: 5 additions & 5 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ jobs:
- uses: technote-space/[email protected]
id: git_diff
with:
SUFFIX_FILTER: |
.go
.mod
.sum
PATTERNS: |
**/**.go
go.mod
go.sum
- run: |
make build
if: "env.GIT_DIFF != ''"
if: env.GIT_DIFF
15 changes: 13 additions & 2 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,16 @@ jobs:

steps:
- name: Checkout repository
uses: actions/checkout@v3
- uses: actions/checkout@v3
- uses: technote-space/[email protected]
with:
PATTERNS: |
**/**.sol
**/**.go
**/**.ts
**/**.js
go.mod
go.sum
# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
Expand All @@ -50,9 +59,10 @@ jobs:
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# queries: ./path/to/local/query, your-org/your-repo/queries@main

if: env.GIT_DIFF
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)

- name: Autobuild
uses: github/codeql-action/autobuild@v1

Expand All @@ -69,3 +79,4 @@ jobs:

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1
if: env.GIT_DIFF
12 changes: 0 additions & 12 deletions .github/workflows/linkchecker.yml

This file was deleted.

22 changes: 18 additions & 4 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ jobs:
- uses: actions/checkout@v3
- uses: technote-space/[email protected]
with:
SUFFIX_FILTER: |
.go
.mod
.sum
PATTERNS: |
**/**.go
go.mod
go.sum
- uses: golangci/golangci-lint-action@v3
with:
# Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
Expand All @@ -28,3 +28,17 @@ jobs:
github-token: ${{ secrets.github_token }}
# Check only if there are differences in the source code
if: "env.GIT_DIFF"
markdown-lint:
name: Run markdown-lint
runs-on: ubuntu-latest
timeout-minutes: 10
steps:
- uses: actions/checkout@v3
- uses: technote-space/[email protected]
with:
PATTERNS: |
docs/**/*.md
README.md
- uses: articulate/[email protected]
# Check only if there are differences in the source code
if: env.GIT_DIFF
3 changes: 1 addition & 2 deletions .github/workflows/stale.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ jobs:
- uses: actions/stale@v4
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
stale-pr-message: "This pull request has been automatically marked as stale because it has not had
recent activity. It will be closed in 7 days-before-close if no further activity occurs."
stale-pr-message: "This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days-before-close if no further activity occurs."
stale-issue-message: "This issue is stale because it has been open 45 days with no activity. Remove `Status: Stale` label or comment or this will be closed in 7 days."
days-before-stale: 45
days-before-close: 7
Expand Down
2 changes: 2 additions & 0 deletions .markdownlint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,6 @@
"MD036": false
"MD040": false
"MD041": false
"MD049":
"style": "asterisk"
"no-hard-tabs": false
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
* [Testing](#testing)
* [Updating Documentation](#updating_doc)
* [Branching Model and Release](#braching_model_and_release)
* [PR Targeting](#pr_targeting)
* [Pull Requests](#pull_requests)
* [Process for reviewing PRs](#reviewing_prs)
* [Pull Merge Procedure](#pull_merge_procedure)
* [Release Procedure](#release_procedure)
* [PR Targeting](#pr_targeting)
* [Pull Requests](#pull_requests)
* [Process for reviewing PRs](#reviewing_prs)
* [Pull Merge Procedure](#pull_merge_procedure)
* [Release Procedure](#release_procedure)

## <span id="general_procedure">General Procedure</span>

Expand Down Expand Up @@ -203,7 +203,7 @@ All PRs require two Reviews before merge. When reviewing PRs, please use the fol
2. Create the release candidate branch `rc/v*` (going forward known as `RC`) and ensure it's protected against pushing
from anyone except the release manager/coordinator. No PRs targeting this branch should be merged unless exceptional
circumstances arise.
3. On the `RC` branch, prepare a new version section in the `CHANGELOG.md`. All links must be link-ified:
3. On the `RC` branch, prepare a new version section in the `CHANGELOG.md`. All links must be link-ified:
`$ python ./scripts/linkify_changelog.py CHANGELOG.md`
Copy the entries into a `RELEASE_CHANGELOG.md`. This is needed so the bot knows which entries to add to the release
page on github.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ The following chat channels and forums are a great spot to ask questions about E

- [Evmos Twitter](https://twitter.com/EvmosOrg)
- [Evmos Discord](https://discord.gg/evmos)
- [Evmos Forum](https://forum.cosmos.network/c/ethermint)
- [Evmos Forum](https://commonwealth.im/evmos)
- [Tharsis Twitter](https://twitter.com/TharsisHQ)

## Contributing
Expand Down
3 changes: 1 addition & 2 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ bounty.

See the policy for more details on submissions and rewards, and see "Example Vulnerabilities" (below) for examples of the kinds of bugs the team is most interested in.


## Guidelines

We require that all researchers:
Expand Down Expand Up @@ -113,4 +112,4 @@ Attacks may come through the P2P network or the RPC layer:
### Light Client

* Core verification
* Bisection/sequential algorithms
* Bisection/sequential algorithms
27 changes: 4 additions & 23 deletions docs/api/json-rpc/endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ Returns Keccak-256 (not the standardized SHA3-256) of the given data.

- Required: ✓ Yes

#### Result
#### Result

```json
{"jsonrpc":"2.0","id":1,"result":"0x1b84adea42d5b7d192fd8a61a85b25abe0757e9a65cab1da470258914053823f"}
Expand Down Expand Up @@ -597,7 +597,7 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getBlockByNumber","params":[

Returns the block info given the hash found in the command above and a bool.

#### Parameters
#### Parameters

- Hash of a block.

Expand Down Expand Up @@ -813,7 +813,6 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_getProof","params":["0x12345
{"jsonrpc": "2.0", "id": 1, "result": {"address": "0x1234567890123456789012345678901234567890", "accountProof": ["0xf90211a090dcaf88c40c7bbc95a912cbdde67c175767b31173df9ee4b0d733bfdd511c43a0babe369f6b12092f49181ae04ca173fb68d1a5456f18d20fa32cba73954052bda0473ecf8a7e36a829e75039a3b055e51b8332cbf03324ab4af2066bbd6fbf0021a0bbda34753d7aa6c38e603f360244e8f59611921d9e1f128372fec0d586d4f9e0a04e44caecff45c9891f74f6a2156735886eedf6f1a733628ebc802ec79d844648a0a5f3f2f7542148c973977c8a1e154c4300fec92f755f7846f1b734d3ab1d90e7a0e823850f50bf72baae9d1733a36a444ab65d0a6faaba404f0583ce0ca4dad92da0f7a00cbe7d4b30b11faea3ae61b7f1f2b315b61d9f6bd68bfe587ad0eeceb721a07117ef9fc932f1a88e908eaead8565c19b5645dc9e5b1b6e841c5edbdfd71681a069eb2de283f32c11f859d7bcf93da23990d3e662935ed4d6b39ce3673ec84472a0203d26456312bbc4da5cd293b75b840fc5045e493d6f904d180823ec22bfed8ea09287b5c21f2254af4e64fca76acc5cd87399c7f1ede818db4326c98ce2dc2208a06fc2d754e304c48ce6a517753c62b1a9c1d5925b89707486d7fc08919e0a94eca07b1c54f15e299bd58bdfef9741538c7828b5d7d11a489f9c20d052b3471df475a051f9dd3739a927c89e357580a4c97b40234aa01ed3d5e0390dc982a7975880a0a089d613f26159af43616fd9455bb461f4869bfede26f2130835ed067a8b967bfb80", "0xf90211a0395d87a95873cd98c21cf1df9421af03f7247880a2554e20738eec2c7507a494a0bcf6546339a1e7e14eb8fb572a968d217d2a0d1f3bc4257b22ef5333e9e4433ca012ae12498af8b2752c99efce07f3feef8ec910493be749acd63822c3558e6671a0dbf51303afdc36fc0c2d68a9bb05dab4f4917e7531e4a37ab0a153472d1b86e2a0ae90b50f067d9a2244e3d975233c0a0558c39ee152969f6678790abf773a9621a01d65cd682cc1be7c5e38d8da5c942e0a73eeaef10f387340a40a106699d494c3a06163b53d956c55544390c13634ea9aa75309f4fd866f312586942daf0f60fb37a058a52c1e858b1382a8893eb9c1f111f266eb9e21e6137aff0dddea243a567000a037b4b100761e02de63ea5f1fcfcf43e81a372dafb4419d126342136d329b7a7ba032472415864b08f808ba4374092003c8d7c40a9f7f9fe9cc8291f62538e1cc14a074e238ff5ec96b810364515551344100138916594d6af966170ff326a092fab0a0d31ac4eef14a79845200a496662e92186ca8b55e29ed0f9f59dbc6b521b116fea090607784fe738458b63c1942bba7c0321ae77e18df4961b2bc66727ea996464ea078f757653c1b63f72aff3dcc3f2a2e4c8cb4a9d36d1117c742833c84e20de994a0f78407de07f4b4cb4f899dfb95eedeb4049aeb5fc1635d65cf2f2f4dfd25d1d7a0862037513ba9d45354dd3e36264aceb2b862ac79d2050f14c95657e43a51b85c80", "0xf90171a04ad705ea7bf04339fa36b124fa221379bd5a38ffe9a6112cb2d94be3a437b879a08e45b5f72e8149c01efcb71429841d6a8879d4bbe27335604a5bff8dfdf85dcea00313d9b2f7c03733d6549ea3b810e5262ed844ea12f70993d87d3e0f04e3979ea0b59e3cdd6750fa8b15164612a5cb6567cdfb386d4e0137fccee5f35ab55d0efda0fe6db56e42f2057a071c980a778d9a0b61038f269dd74a0e90155b3f40f14364a08538587f2378a0849f9608942cf481da4120c360f8391bbcc225d811823c6432a026eac94e755534e16f9552e73025d6d9c30d1d7682a4cb5bd7741ddabfd48c50a041557da9a74ca68da793e743e81e2029b2835e1cc16e9e25bd0c1e89d4ccad6980a041dda0a40a21ade3a20fcd1a4abb2a42b74e9a32b02424ff8db4ea708a5e0fb9a09aaf8326a51f613607a8685f57458329b41e938bb761131a5747e066b81a0a16808080a022e6cef138e16d2272ef58434ddf49260dc1de1f8ad6dfca3da5d2a92aaaadc58080", "0xf851808080a009833150c367df138f1538689984b8a84fc55692d3d41fe4d1e5720ff5483a6980808080808080808080a0a319c1c415b271afc0adcb664e67738d103ac168e0bc0b7bd2da7966165cb9518080"], "balance": "0x0", "codeHash": "0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470", "nonce": "0x0", "storageHash": "0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421", "storageProof": [{"key": "0x0000000000000000000000000000000000000000000000000000000000000000", "value": "0x0", "proof": []}, {"key": "0x0000000000000000000000000000000000000000000000000000000000000001", "value": "0x0", "proof": []}]}}
```


## WebSocket Methods

Read about websockets in [events](./events.md)
Expand Down Expand Up @@ -876,8 +875,6 @@ Returns the address of the new account.

- Required: ✓ Yes



```json
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"personal_importRawKey","params":["c5bd76cd0cd948de17a31261567d219576e992d9066fe1a6bca97496dec634e2c8e06f8949773b300b9f73fabbbc7710d5d6691e96bcf3c9145e15daf6fe07b9", "the key is this"],"id":1}' -H "Content-Type: application/json" http://localhost:8545
Expand Down Expand Up @@ -1062,7 +1059,7 @@ Parameters must be given by position.

1: url `string`

- Required: ✓ Yes
- Required: ✓ Yes

#### Client Examples

Expand Down Expand Up @@ -1090,7 +1087,6 @@ personal.initializeWallet(url);
:::
::::


### `personal_unpair`

::: tip
Expand Down Expand Up @@ -1131,8 +1127,6 @@ personal.unpair(url,pin);
:::
::::



## Debug Methods

### `debug_traceTransaction`
Expand Down Expand Up @@ -1167,7 +1161,6 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"debug_traceBlockByNumber","param
{"jsonrpc":"2.0","id":1,"result":[{"result":["68410", "51470"]}]}
```


## Miner Methods

### `miner_getHashrate`
Expand Down Expand Up @@ -1297,19 +1290,7 @@ Unsupported. This endpoint always returns `false`

```json
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"miner_start","params":["0x10000"],"id":1}' -H "Content-Type: application/json" http://localhost:8545

// Result
{"jsonrpc":"2.0","id":1,"result":false}
```

#### Parameters

- Hex Number of threads

```json
// Request
curl -X POST --data '{"jsonrpc":"2.0","method":"miner_start","params":["0x1"],"id":1}' -H "Content-Type: application/json" http://localhost:8545
curl -X POST --data '{"jsonrpc":"2.0","method":"miner_setGasLimit","params":["0x10000"],"id":1}' -H "Content-Type: application/json" http://localhost:8545

// Result
{"jsonrpc":"2.0","id":1,"result":false}
Expand Down
4 changes: 2 additions & 2 deletions docs/clients/apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
# Evmos APIs

::: tip
🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧
🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧

This documentation page is currently under work in progress.

🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧
🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧
:::

## Public Testnet Nodes
Expand Down
4 changes: 2 additions & 2 deletions docs/clients/evmosjs.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ Use the evmosjs library for connecting clients to Evmos {synopsis}
[`evmosjs`](https://github.com/tharsis/evmosjs) is a JavaScript and TypeScript client library for [Evmos](https://github.com/tharsis/evmos) and [Ethermint](https://github.com/tharsis/ethermint) nodes.

::: tip
🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧
🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧

This documentation page is currently under work in progress.

🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧
🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧 🚧
:::

## Cosmjs
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/keys-wallets/keyring.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ is a list of the most popular operating systems and their respective passwords m
- macOS (since Mac OS 8.6): [Keychain](https://support.apple.com/en-gb/guide/keychain-access/welcome/mac)
- Windows: [Credentials Management API](https://docs.microsoft.com/en-us/windows/win32/secauthn/credentials-management)
- GNU/Linux:
- [libsecret](https://gitlab.gnome.org/GNOME/libsecret)
- [kwallet](https://api.kde.org/frameworks/kwallet/html/index.html)
- [libsecret](https://gitlab.gnome.org/GNOME/libsecret)
- [kwallet](https://api.kde.org/frameworks/kwallet/html/index.html)

GNU/Linux distributions that use GNOME as default desktop environment typically come with
[Seahorse](https://wiki.gnome.org/Apps/Seahorse). Users of KDE based distributions are
Expand Down
8 changes: 4 additions & 4 deletions docs/guides/upgrades/upgrade_node.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ cp $GOPATH/bin/evmosd ~/.evmosd/cosmovisor/genesis/bin
```

To check that you did this correctly, ensure your versions of cosmovisor and evmosd are the same:

```
cosmovisor version
evmosd version
Expand All @@ -100,13 +101,12 @@ It is possible to have Cosmovisor automatically download the new binary. To do t
echo "export DAEMON_ALLOW_DOWNLOAD_BINARIES=true" >> ~/.profile
```


#### Download Genesis File

You can now download the "genesis" file for the chain. It is pre-filled with the entire genesis state and gentxs.

```bash
$ curl https://raw.githubusercontent.com/tharsis/testnets/main/olympus_mons/genesis.json > ~/.evmosd/config/genesis.json
curl https://raw.githubusercontent.com/tharsis/testnets/main/olympus_mons/genesis.json > ~/.evmosd/config/genesis.json
```

We recommend using `sha256sum` to check the hash of the genesis.
Expand Down Expand Up @@ -204,6 +204,7 @@ systemctl status evmosd
#### Update Cosmosvisor to V2

If you're not yet on the latest V1 release (`v1.1.2`) please upgrade your current version first:

```bash
cd $HOME/evmos
git pull
Expand All @@ -215,8 +216,8 @@ systemctl start evmosd.service
cd $HOME
```


If you are on the latest V1 release (`v1.1.2`) and you want evmosd to upgrade automatically from V1 to V2, do the following steps prior to the upgrade height:

```bash
mkdir -p ~/.evmosd/cosmovisor/upgrades/v2/bin
cd $HOME/evmos
Expand Down Expand Up @@ -253,7 +254,6 @@ cp -f genesis.json new_genesis.json
mv new_genesis.json genesis.json
```


#### Export State

Evmos can dump the entire application state to a JSON file. This, besides upgrades, can be
Expand Down
Loading

0 comments on commit c573337

Please sign in to comment.