Skip to content

Commit

Permalink
ameba: Remove ameba from shard dependencies
Browse files Browse the repository at this point in the history
Ameba is a linting tool, which isn't being used in our CI
pipelines, and causes complications with crystal version update.
Ameba dependency should be removed from cnf-testcatalog shards
and usage guidelines should point to more independent usage via
installing the linter from source.

Refs: cnti-testcatalog#2157
Signed-off-by: Konstantin Yarovoy <[email protected]>
  • Loading branch information
Konstantin Yarovoy committed Sep 27, 2024
1 parent 6c76d20 commit 8c08d15
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 13 deletions.
11 changes: 7 additions & 4 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,15 +171,18 @@ CNF_TESTSUITE_LITMUS_CHAOS_TEST_TIMEOUT=1800
CNF_TESTSUITE_NODE_DRAIN_TOTAL_CHAOS_DURATION=90
```

#### Running The Linter in Developer Mode
#### Running The Linter

See https://github.com/crystal-ameba/ameba for more details. Follow the [INSTALL](INSTALL.md) guide starting at the [Source Install](INSTALL.md#source-install) for more details running cnf-testsuite in developer mode.
Ameba (https://github.com/crystal-ameba/ameba) is a static code linter for crystal-lang.
To run Ameba, you need to install testsuite in developer mode ([Source Install](INSTALL.md#source-install)) and use installation from source method for Ameba, which is mentioned in Ameba readme.md:

```
shards install # only for first install
crystal bin/ameba.cr
git clone https://github.com/crystal-ameba/ameba && cd ameba
make install
```

After that, follow the usage guidelines from the Ameba repository.

### Usage for categories and single tests

It's located in [TEST_DOCUMENTATION](docs/TEST_DOCUMENTATION.md), Check for needed category or test there.
4 changes: 0 additions & 4 deletions shard.lock
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
version: 2.0
shards:
ameba:
git: https://github.com/crystal-ameba/ameba.git
version: 1.3.1

cluster_tools:
git: https://github.com/cnf-testsuite/cluster_tools.git
version: 1.0.7
Expand Down
5 changes: 0 additions & 5 deletions shard.yml
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,4 @@ dependencies:
protobuf:
github: jeromegn/protobuf.cr

development_dependencies:
ameba:
github: crystal-ameba/ameba
version: ~> 1.3.1

license: MIT

0 comments on commit 8c08d15

Please sign in to comment.