项目作者: roxspring

项目描述 :
Example of a custom Zally RuleSet
高级语言: Kotlin
项目地址: git://github.com/roxspring/zally-ruleset-example.git
创建时间: 2020-02-12T21:28:26Z
项目社区:https://github.com/roxspring/zally-ruleset-example

开源协议:

下载


Zally RuleSet Example

Note this is work in progress!!

ExampleEgoRule

A daft example rule which simply insists that API descriptions refer to “Example Corp”.

Gradle

  1. ./gradlew build

Note that there is currently no official public maven repository to supply dependencies.
This example uses a http://jitpack.io repository to access the latest master-SNAPSHOT.
Tracked in Zally issue #964.

Docker

A test server can be run via docker using the following commands:

  1. docker build . -t zally_example
  2. docker run --rm -it -p8000:8000 zally_example

Note that there are currently no official public docker images to run your ruleset in.
This example assumes a local zally_server image exists with the server built.
Tracked in Zally issue #761.

The rules are patched into zally.jar during the build phase for now,
one day there should be a much cleaner mechanism but for now this is
the best I could come up with.
Tracked in Zally issue #560.

Testing

Use a browser to load the server’s list of supported rules:

http://localhost:8000/supported-rules

All being well you should be able to see reference to ExampleEgoRule and
a link back to this document in the resulting JSON.