You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by "sakulali (via GitHub)" <gi...@apache.org> on 2023/02/13 13:21:17 UTC
[GitHub] [apisix-ingress-controller] sakulali opened a new pull request, #1666: ci: add yamllint rules
sakulali opened a new pull request, #1666:
URL: https://github.com/apache/apisix-ingress-controller/pull/1666
<!-- Please answer these questions before submitting a pull request -->
### Type of change:
fix: #1062
Add `yamllint` rules check `samples/deploy/` directory
<!-- Please delete options that are not relevant. -->
<!-- Select all the options from below that matches the type your PR best -->
- [ ] Bugfix
- [ ] New feature provided
- [ ] Improve performance
- [ ] Backport patches
- [ ] Documentation
- [ ] Refactor
- [ ] Chore
- [ ] CI/CD or Tests
### What this PR does / why we need it:
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->
### Pre-submission checklist:
<!--
Please follow the requirements:
1. Use Draft if the PR is not ready to be reviewed
2. Test is required for the feat/fix PR, unless you have a good reason
3. Doc is required for the feat PR
4. Use a new commit to resolve review instead of `push -f`
5. Use "request review" to notify the reviewer once you have resolved the review
-->
- [ ] Did you explain what problem does this PR solve? Or what new features have been added?
- [ ] Have you added corresponding test cases?
- [ ] Have you modified the corresponding document?
- [ ] Is this PR backward compatible? **If it is not backward compatible, please discuss on the [mailing list](https://github.com/apache/apisix-ingress-controller#community) first**
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] codecov-commenter commented on pull request #1666: ci: add yamllint rules
Posted by "codecov-commenter (via GitHub)" <gi...@apache.org>.
codecov-commenter commented on PR #1666:
URL: https://github.com/apache/apisix-ingress-controller/pull/1666#issuecomment-1442869175
# [Codecov](https://codecov.io/gh/apache/apisix-ingress-controller/pull/1666?src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) Report
> Merging [#1666](https://codecov.io/gh/apache/apisix-ingress-controller/pull/1666?src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) (4d57b8b) into [master](https://codecov.io/gh/apache/apisix-ingress-controller/commit/88d04f2916082e3a068cef79e716ced63abf1c30?el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) (88d04f2) will **increase** coverage by `0.40%`.
> The diff coverage is `61.73%`.
> :exclamation: Current head 4d57b8b differs from pull request most recent head 6a37796. Consider uploading reports for the commit 6a37796 to get more accurate results
```diff
@@ Coverage Diff @@
## master #1666 +/- ##
==========================================
+ Coverage 41.02% 41.42% +0.40%
==========================================
Files 88 88
Lines 7564 7642 +78
==========================================
+ Hits 3103 3166 +63
- Misses 4101 4112 +11
- Partials 360 364 +4
```
| [Impacted Files](https://codecov.io/gh/apache/apisix-ingress-controller/pull/1666?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation) | Coverage Ξ | |
|---|---|---|
| [pkg/providers/ingress/ingress.go](https://codecov.io/gh/apache/apisix-ingress-controller/pull/1666?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-cGtnL3Byb3ZpZGVycy9pbmdyZXNzL2luZ3Jlc3MuZ28=) | `4.00% <0.00%> (-0.05%)` | :arrow_down: |
| [pkg/providers/ingress/translation/translator.go](https://codecov.io/gh/apache/apisix-ingress-controller/pull/1666?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-cGtnL3Byb3ZpZGVycy9pbmdyZXNzL3RyYW5zbGF0aW9uL3RyYW5zbGF0b3IuZ28=) | `0.00% <0.00%> (ΓΈ)` | |
| [pkg/providers/utils/status.go](https://codecov.io/gh/apache/apisix-ingress-controller/pull/1666?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-cGtnL3Byb3ZpZGVycy91dGlscy9zdGF0dXMuZ28=) | `30.43% <77.77%> (+30.43%)` | :arrow_up: |
| [pkg/providers/utils/ingress\_status.go](https://codecov.io/gh/apache/apisix-ingress-controller/pull/1666?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-cGtnL3Byb3ZpZGVycy91dGlscy9pbmdyZXNzX3N0YXR1cy5nbw==) | `37.50% <84.37%> (+37.50%)` | :arrow_up: |
| [cmd/ingress/ingress.go](https://codecov.io/gh/apache/apisix-ingress-controller/pull/1666?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-Y21kL2luZ3Jlc3MvaW5ncmVzcy5nbw==) | `82.90% <100.00%> (+0.14%)` | :arrow_up: |
| [pkg/config/config.go](https://codecov.io/gh/apache/apisix-ingress-controller/pull/1666?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation#diff-cGtnL2NvbmZpZy9jb25maWcuZ28=) | `63.91% <100.00%> (+0.37%)` | :arrow_up: |
:mega: Weβre building smart automated test selection to slash your CI/CD build times. [Learn more](https://about.codecov.io/iterative-testing/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=The+Apache+Software+Foundation)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] tao12345666333 commented on a diff in pull request #1666: ci: add yamllint rules
Posted by "tao12345666333 (via GitHub)" <gi...@apache.org>.
tao12345666333 commented on code in PR #1666:
URL: https://github.com/apache/apisix-ingress-controller/pull/1666#discussion_r1112562109
##########
.yamllint.yml:
##########
@@ -0,0 +1,49 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+---
+
+yaml-files:
+ - '*.yaml'
+ - '*.yml'
+ - '.yamllint'
+
+rules:
+ braces: disable # default: enable
+ brackets: disable # default: enable
+ colons: enable
+ commas: disable # default: enable
+ comments: disable # default: {level: warning}
+ comments-indentation: disable # default: {level: warning}
+ document-end: disable
+ document-start: disable # default: {level: warning}
+ empty-lines: enable
+ empty-values: disable
+ float-values: disable
+ hyphens: enable
+ indentation: disable # default: enable
Review Comment:
@sakulali we should enable these options and fix the format of YAML. Thanks
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] sakulali commented on pull request #1666: ci: add yamllint rules
Posted by "sakulali (via GitHub)" <gi...@apache.org>.
sakulali commented on PR #1666:
URL: https://github.com/apache/apisix-ingress-controller/pull/1666#issuecomment-1451315616
@lingsamuel, @AlinsRan, would you do me a favor to review this pr, thanks!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] tao12345666333 commented on a diff in pull request #1666: ci: add yamllint rules
Posted by "tao12345666333 (via GitHub)" <gi...@apache.org>.
tao12345666333 commented on code in PR #1666:
URL: https://github.com/apache/apisix-ingress-controller/pull/1666#discussion_r1121099401
##########
Makefile:
##########
@@ -222,9 +222,19 @@ verify-license:
verify-mdlint:
docker run -it --rm -v $(PWD):/work tmknom/markdownlint '**/*.md' --ignore node_modules --ignore CHANGELOG.md
+### verify-yamllint: Verify yaml files lint rules for `samples/deploy` directory.
+.PHONY: verify-yamllint
+verify-yamllint:
+ docker run -it --rm -v $(PWD):/yaml peterdavehello/yamllint yamllint samples/deploy
+
### verify-all: Verify all verify- rules.
.PHONY: verify-all
-verify-all: verify-codegen verify-license verify-mdlint
+verify-all: verify-codegen verify-license verify-mdlint verify-yamllint
+
+### update-yamlfmt: Update yaml files format for `samples/deploy` directory.
+.PHONY: update-yamlfmt
+update-yamlfmt:
+ go install github.com/google/yamlfmt/cmd/yamlfmt@latest && yamlfmt samples/deploy
Review Comment:
The `peterdavehello/yamllint ` image is Dockerized https://github.com/adrienverge/yamllint
But in the `update-yamlfmt` job you install https://github.com/google/yamlfmt, why?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] sakulali commented on a diff in pull request #1666: ci: add yamllint rules
Posted by "sakulali (via GitHub)" <gi...@apache.org>.
sakulali commented on code in PR #1666:
URL: https://github.com/apache/apisix-ingress-controller/pull/1666#discussion_r1118979933
##########
.yamllint.yml:
##########
@@ -0,0 +1,49 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+---
+
+yaml-files:
+ - '*.yaml'
+ - '*.yml'
+ - '.yamllint'
+
+rules:
+ braces: disable # default: enable
+ brackets: disable # default: enable
+ colons: enable
+ commas: disable # default: enable
+ comments: disable # default: {level: warning}
+ comments-indentation: disable # default: {level: warning}
+ document-end: disable
+ document-start: disable # default: {level: warning}
+ empty-lines: enable
+ empty-values: disable
+ float-values: disable
+ hyphens: enable
+ indentation: disable # default: enable
Review Comment:
> @sakulali we should enable these options and fix the format of YAML. Thanks
@tao12345666333 , Sorry for delay, when i use [https://github.com/google/yamlfmt](url) to fix the format of YAML, there are too much differences vs original files, too much change maybe not good?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] sakulali commented on a diff in pull request #1666: ci: add yamllint rules
Posted by "sakulali (via GitHub)" <gi...@apache.org>.
sakulali commented on code in PR #1666:
URL: https://github.com/apache/apisix-ingress-controller/pull/1666#discussion_r1112131086
##########
.yamllint.yml:
##########
@@ -0,0 +1,49 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+---
+
+yaml-files:
+ - '*.yaml'
+ - '*.yml'
+ - '.yamllint'
+
+rules:
+ braces: disable # default: enable
+ brackets: disable # default: enable
+ colons: enable
+ commas: disable # default: enable
+ comments: disable # default: {level: warning}
+ comments-indentation: disable # default: {level: warning}
+ document-end: disable
+ document-start: disable # default: {level: warning}
+ empty-lines: enable
+ empty-values: disable
+ float-values: disable
+ hyphens: enable
+ indentation: disable # default: enable
Review Comment:
@tao12345666333 When i enable `empty-values` or `indentation` options, i find some error in CI action as shown below, then i use [https://www.json2yaml.com/convert-yaml-to-json](url) tool to check yaml file it seems valid, so maybe we can disabled it?
<img width="847" alt="image" src="https://user-images.githubusercontent.com/3955787/220154262-51d50015-6604-4b7c-836b-8c4012fcdb97.png">
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] sakulali commented on a diff in pull request #1666: ci: add yamllint rules
Posted by "sakulali (via GitHub)" <gi...@apache.org>.
sakulali commented on code in PR #1666:
URL: https://github.com/apache/apisix-ingress-controller/pull/1666#discussion_r1112132242
##########
.github/workflows/yamllint-checker.yml:
##########
@@ -0,0 +1,68 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+name: yamllint-checker
+
+on:
+ push:
+ branches:
+ - master
+ pull_request:
+ branches:
+ - master
+ - v1.6.0
+ type: [review_requested, ready_for_review]
+jobs:
+ changes:
+ runs-on: ubuntu-latest
+ outputs:
+ yaml: ${{ steps.filter.outputs.yaml }}
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v3
+ with:
+ submodules: recursive
+
+ - uses: ./.github/actions/paths-filter
+ id: filter
+ with:
+ token: ${{ secrets.GITHUB_TOKEN }}
+ # focus on `samples/deploy` yaml files directory
+ filters: |
+ yaml:
+ - 'samples/deploy/**/*'
+ yamllint-checker:
+ needs: changes
+ if: |
+ (needs.changes.outputs.yaml == 'true')
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ - uses: actions/setup-python@v4
+ with:
+ python-version: '3.10'
+ - run: pip install yamllint==1.29.0
+ - name: π Run yamllint
+ run: yamllint samples/deploy # focus on `samples/deploy` yaml files directory
+
+ # Run GitHub Actions locally (nektos/act)
+ # - name: π Run yamllint
+ # run: |
+ # make verify-yamllint
+
+
Review Comment:
@tao12345666333 , done, thanks
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] tao12345666333 commented on a diff in pull request #1666: ci: add yamllint rules
Posted by "tao12345666333 (via GitHub)" <gi...@apache.org>.
tao12345666333 commented on code in PR #1666:
URL: https://github.com/apache/apisix-ingress-controller/pull/1666#discussion_r1119025996
##########
.yamllint.yml:
##########
@@ -0,0 +1,49 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+---
+
+yaml-files:
+ - '*.yaml'
+ - '*.yml'
+ - '.yamllint'
+
+rules:
+ braces: disable # default: enable
+ brackets: disable # default: enable
+ colons: enable
+ commas: disable # default: enable
+ comments: disable # default: {level: warning}
+ comments-indentation: disable # default: {level: warning}
+ document-end: disable
+ document-start: disable # default: {level: warning}
+ empty-lines: enable
+ empty-values: disable
+ float-values: disable
+ hyphens: enable
+ indentation: disable # default: enable
Review Comment:
don't worry. It doesn't have any real impact on users.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] tao12345666333 commented on a diff in pull request #1666: ci: add yamllint rules
Posted by "tao12345666333 (via GitHub)" <gi...@apache.org>.
tao12345666333 commented on code in PR #1666:
URL: https://github.com/apache/apisix-ingress-controller/pull/1666#discussion_r1122259467
##########
Makefile:
##########
@@ -222,9 +222,19 @@ verify-license:
verify-mdlint:
docker run -it --rm -v $(PWD):/work tmknom/markdownlint '**/*.md' --ignore node_modules --ignore CHANGELOG.md
+### verify-yamllint: Verify yaml files lint rules for `samples/deploy` directory.
+.PHONY: verify-yamllint
+verify-yamllint:
+ docker run -it --rm -v $(PWD):/yaml peterdavehello/yamllint yamllint samples/deploy
+
### verify-all: Verify all verify- rules.
.PHONY: verify-all
-verify-all: verify-codegen verify-license verify-mdlint
+verify-all: verify-codegen verify-license verify-mdlint verify-yamllint
+
+### update-yamlfmt: Update yaml files format for `samples/deploy` directory.
+.PHONY: update-yamlfmt
+update-yamlfmt:
+ go install github.com/google/yamlfmt/cmd/yamlfmt@latest && yamlfmt samples/deploy
Review Comment:
Yes, I know, so I approved this PR
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] tao12345666333 commented on a diff in pull request #1666: ci: add yamllint rules
Posted by "tao12345666333 (via GitHub)" <gi...@apache.org>.
tao12345666333 commented on code in PR #1666:
URL: https://github.com/apache/apisix-ingress-controller/pull/1666#discussion_r1111045789
##########
.yamllint.yml:
##########
@@ -0,0 +1,49 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+---
+
+yaml-files:
+ - '*.yaml'
+ - '*.yml'
+ - '.yamllint'
+
+rules:
+ braces: disable # default: enable
+ brackets: disable # default: enable
+ colons: enable
+ commas: disable # default: enable
+ comments: disable # default: {level: warning}
+ comments-indentation: disable # default: {level: warning}
+ document-end: disable
+ document-start: disable # default: {level: warning}
+ empty-lines: enable
+ empty-values: disable
+ float-values: disable
+ hyphens: enable
+ indentation: disable # default: enable
Review Comment:
Why disabled it?
##########
.github/workflows/yamllint-checker.yml:
##########
@@ -0,0 +1,68 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+name: yamllint-checker
+
+on:
+ push:
+ branches:
+ - master
+ pull_request:
+ branches:
+ - master
+ - v1.6.0
+ type: [review_requested, ready_for_review]
+jobs:
+ changes:
+ runs-on: ubuntu-latest
+ outputs:
+ yaml: ${{ steps.filter.outputs.yaml }}
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v3
+ with:
+ submodules: recursive
+
+ - uses: ./.github/actions/paths-filter
+ id: filter
+ with:
+ token: ${{ secrets.GITHUB_TOKEN }}
+ # focus on `samples/deploy` yaml files directory
+ filters: |
+ yaml:
+ - 'samples/deploy/**/*'
+ yamllint-checker:
+ needs: changes
+ if: |
+ (needs.changes.outputs.yaml == 'true')
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ - uses: actions/setup-python@v4
+ with:
+ python-version: '3.10'
+ - run: pip install yamllint==1.29.0
+ - name: π Run yamllint
+ run: yamllint samples/deploy # focus on `samples/deploy` yaml files directory
+
+ # Run GitHub Actions locally (nektos/act)
+ # - name: π Run yamllint
+ # run: |
+ # make verify-yamllint
+
+
Review Comment:
remove these lines
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] sakulali commented on a diff in pull request #1666: ci: add yamllint rules
Posted by "sakulali (via GitHub)" <gi...@apache.org>.
sakulali commented on code in PR #1666:
URL: https://github.com/apache/apisix-ingress-controller/pull/1666#discussion_r1122014446
##########
Makefile:
##########
@@ -222,9 +222,19 @@ verify-license:
verify-mdlint:
docker run -it --rm -v $(PWD):/work tmknom/markdownlint '**/*.md' --ignore node_modules --ignore CHANGELOG.md
+### verify-yamllint: Verify yaml files lint rules for `samples/deploy` directory.
+.PHONY: verify-yamllint
+verify-yamllint:
+ docker run -it --rm -v $(PWD):/yaml peterdavehello/yamllint yamllint samples/deploy
+
### verify-all: Verify all verify- rules.
.PHONY: verify-all
-verify-all: verify-codegen verify-license verify-mdlint
+verify-all: verify-codegen verify-license verify-mdlint verify-yamllint
+
+### update-yamlfmt: Update yaml files format for `samples/deploy` directory.
+.PHONY: update-yamlfmt
+update-yamlfmt:
+ go install github.com/google/yamlfmt/cmd/yamlfmt@latest && yamlfmt samples/deploy
Review Comment:
@tao12345666333 , I found `yamllint` is a linter without support formating YAML https://github.com/adrienverge/yamllint/issues/62#issuecomment-679873297 , and i found another tool [https://github.com/google/yamlfmt](url) to fix the format of YAML.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] lingsamuel merged pull request #1666: ci: add yamllint rules
Posted by "lingsamuel (via GitHub)" <gi...@apache.org>.
lingsamuel merged PR #1666:
URL: https://github.com/apache/apisix-ingress-controller/pull/1666
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] sakulali commented on pull request #1666: ci: add yamllint rules
Posted by "sakulali (via GitHub)" <gi...@apache.org>.
sakulali commented on PR #1666:
URL: https://github.com/apache/apisix-ingress-controller/pull/1666#issuecomment-1427987537
@tao12345666333 PTAL, thanks!
If it need `yamllint` for CI, refer to [https://github.com/marketplace/actions/super-linter](url), we can merge yamllint action into `lint-checker.yml`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org