You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by kv...@apache.org on 2020/12/22 05:16:39 UTC
[apisix-docker] branch master updated: feat: add a GitHub Action to
lint the Markdown (#105)
This is an automated email from the ASF dual-hosted git repository.
kvn pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix-docker.git
The following commit(s) were added to refs/heads/master by this push:
new f5c17e0 feat: add a GitHub Action to lint the Markdown (#105)
f5c17e0 is described below
commit f5c17e0fa8d515c69d8dc4ed37a5efb917c30a29
Author: John Bampton <jb...@users.noreply.github.com>
AuthorDate: Tue Dec 22 15:12:23 2020 +1000
feat: add a GitHub Action to lint the Markdown (#105)
Add a `.markdownlint.yml` config file
Lint Markdown for:
- MD009/no-trailing-spaces Trailing spaces
- MD012/no-multiple-blanks Multiple consecutive blank lines
- MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines
- MD034/no-bare-urls Bare URL used
- MD038/no-space-in-code Spaces inside code span elements
- MD047/single-trailing-newline Files should end with a single newline character
---
.github/workflows/lint.yml | 16 ++++++++++++++++
.markdownlint.yml | 26 ++++++++++++++++++++++++++
README.md | 3 +--
build.md | 2 +-
example/mkcert/README.md | 2 +-
manual.md | 13 ++++++-------
6 files changed, 51 insertions(+), 11 deletions(-)
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
new file mode 100644
index 0000000..3a283bb
--- /dev/null
+++ b/.github/workflows/lint.yml
@@ -0,0 +1,16 @@
+name: ❄️ Lint
+
+on: [pull_request]
+
+jobs:
+ markdownlint:
+ name: 🍇 Markdown
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ - name: 🚀 Use Node.js
+ uses: actions/setup-node@v1
+ with:
+ node-version: '12.x'
+ - run: npm install -g markdownlint-cli@0.25.0
+ - run: markdownlint '**/*.md' --ignore node_modules
diff --git a/.markdownlint.yml b/.markdownlint.yml
new file mode 100644
index 0000000..c3f0a9d
--- /dev/null
+++ b/.markdownlint.yml
@@ -0,0 +1,26 @@
+# MD013/line-length Line length
+MD013: false
+
+# MD014/commands-show-output Dollar signs used before commands without showing output
+MD014: false
+
+# MD029/ol-prefix Ordered list item prefix
+MD019: false
+
+# MD029/ol-prefix Ordered list item prefix
+MD029: false
+
+# MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines
+MD031: false
+
+# MD032/blanks-around-lists Lists should be surrounded by blank lines
+MD032: false
+
+# MD036/no-emphasis-as-heading/no-emphasis-as-header Emphasis used instead of a heading
+MD036: false
+
+# MD040/fenced-code-language Fenced code blocks should have a language specified
+MD040: false
+
+# MD041/first-line-heading/first-line-h1 First line in file should be a top level heading
+MD041: false
diff --git a/README.md b/README.md
index 4a69094..3d2092f 100644
--- a/README.md
+++ b/README.md
@@ -22,7 +22,7 @@ docker build -t apisix:${APISIX_VERSION}-alpine --build-arg APISIX_VERSION=${API
### Manual deploy apisix via docker
-[Manual deploy](manual.md)
+[Manual deploy](manual.md)
### QuickStart via docker-compose
@@ -58,4 +58,3 @@ Tips: If there is a port conflict, please modify the host port through `docker r
```shell
$ docker run -v `pwd`/all-in-one/apisix/config.yaml:/usr/local/apisix/conf/config.yaml -v `pwd`/all-in-one/apisix-dashboard/conf.yaml:/usr/local/apisix-dashboard/conf/conf.yaml -p 19080:9080 -p 12379:2379 -p 19000:9000 -d apache/apisix-dashboard:whole
```
-
diff --git a/build.md b/build.md
index 1978239..2a8e283 100644
--- a/build.md
+++ b/build.md
@@ -13,4 +13,4 @@ docker build -t apisix:${APISIX_VERSION}-alpine --build-arg APISIX_VERSION=${API
2. install master branch version, which has latest code(ONLY for the developer's convenience):
```
docker build -t apisix:master-alpine -f alpine/Dockerfile alpine
-```
\ No newline at end of file
+```
diff --git a/example/mkcert/README.md b/example/mkcert/README.md
index c9ffca8..0a18f61 100644
--- a/example/mkcert/README.md
+++ b/example/mkcert/README.md
@@ -1,6 +1,6 @@
### Ref
-https://github.com/FiloSottile/mkcert
+<https://github.com/FiloSottile/mkcert>
### Copy CA
diff --git a/manual.md b/manual.md
index 8c07451..c579d48 100644
--- a/manual.md
+++ b/manual.md
@@ -11,10 +11,9 @@ docker network create \
apisix
```
-### Run etcd server with `apisix` network
+### Run etcd server with `apisix` network
-
-Specify ip `172.18.5.10`
+Specify ip `172.18.5.10`
```
docker run -it --name etcd-server \
@@ -29,7 +28,7 @@ docker run -it --name etcd-server \
> Note:
>
> 1. windows OS use absolute paths to hang in the configuration file.
-> 2. e.g：windows dir path `E:\GitHub\docker-apisix `，configuration file hang path is `-v /e/github/docker-apisix/example/etcd_conf/etcd.conf.yml:/opt/bitnami/etcd/conf/etcd.conf.yml`
+> 2. e.g：windows dir path `E:\GitHub\docker-apisix`，configuration file hang path is `-v /e/github/docker-apisix/example/etcd_conf/etcd.conf.yml:/opt/bitnami/etcd/conf/etcd.conf.yml`
### Run Apache APISIX server
@@ -55,10 +54,9 @@ docker run --name test-api-gateway \
> 1. windows OS use absolute paths to hang in the configuration file and log dir.
>
-
### Have a test
-Test with admin api
+Test with admin api
e.g. Get route list, should be return
@@ -69,8 +67,9 @@ curl http://127.0.0.1:9080/apisix/admin/routes/
```
### Clean
+
```
docker rm test-api-gateway
docker rm etcd-server
docker network rm apisix
-```
\ No newline at end of file
+```