Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Separate markdown check by reviewdog #1890

Merged

Conversation

vankichi
Copy link
Contributor

Description:

I have updated the workflow to check markdown files by language tools.
It is because the required checkpoint differs between document files and auto-generated markdown files.
I have changed the following:

  • md files under the apis/ and chats/: add ignore rules CASING
  • except: No change

Related Issue:

Versions:

  • Go Version: 1.19.4
  • Docker Version: 20.10.8
  • Kubernetes Version: 1.22.0
  • NGT Version: 1.14.8

Checklist:

Special notes for your reviewer:

@vdaas-ci
Copy link
Collaborator

[CHATOPS:HELP] ChatOps commands.

  • 🙆‍♀️ /approve - approve
  • 💌 /changelog - replace the PR body by changelog details
  • 🍱 /format - format codes and add licenses
  • /gen-test - generate test codes
  • 🏷️ /label - add labels
  • /rebase - rebase main
  • 🔚 2️⃣ 🔚 /label actions/e2e-deploy - run E2E deploy & integration test

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Dec 12, 2022

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: e98806f
Status: ✅  Deploy successful!
Preview URL: https://91cfed65.vald.pages.dev
Branch Preview URL: https://refactor-ci-separate-markdow.vald.pages.dev

View logs

@vankichi vankichi force-pushed the refactor/ci/separate-markdown-check branch 4 times, most recently from 1713c81 to 7b5a553 Compare December 12, 2022 07:11
Signed-off-by: vankichi <kyukawa315@gmail.com>
@@ -35,7 +35,25 @@ jobs:
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
reporter: github-pr-review
patterns: "**/*.md **/*.md.gotmpl !**/CHANGELOG.md"
patterns: "apis/**/*.md apis/**/*.md.gotmpl charts/**/*.md !charts/vald/README.md"
Copy link
Contributor Author

@vankichi vankichi Dec 12, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have ignored charts/vald/README.md because of the args error.
reviewdog/actions-languagetool uses cat command when sending the request with file raw data.
When the file has more characters than the limit, it will be failed like chats/vald/README.md.
https://github.com/reviewdog/action-languagetool/blob/master/entrypoint.sh#L48

Copy link
Collaborator

@kpango kpango left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@vankichi vankichi merged commit 4319e75 into deepsource-transform-885bce66 Dec 13, 2022
@vankichi vankichi deleted the refactor/ci/separate-markdown-check branch December 13, 2022 07:30
kpango added a commit that referenced this pull request Dec 16, 2022
* Format code with prettier and gofumpt

This commit fixes the style issues introduced in 4e10e17 according to the output
from prettier and gofumpt.

Details: https://deepsource.io/gh/vdaas/vald/transform/3468f768-127e-425d-9457-42cc8d2ef2b2/

* Fix grammar (#1889)

* Fix grammar

Signed-off-by: vankichi <kyukawa315@gmail.com>

* Format code with prettier and gofumpt

* Fix grammar

Signed-off-by: vankichi <kyukawa315@gmail.com>

* Format code with prettier and gofumpt

Signed-off-by: vankichi <kyukawa315@gmail.com>
Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com>

* 💚 Separate language tool (#1890)

Signed-off-by: vankichi <kyukawa315@gmail.com>

Signed-off-by: vankichi <kyukawa315@gmail.com>

Signed-off-by: vankichi <kyukawa315@gmail.com>
Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com>
Co-authored-by: Yusuke Kato <kpango@vdaas.org>
Co-authored-by: Kiichiro YUKAWA <kyukawa315@gmail.com>
takuyaymd pushed a commit to aknishid/vald that referenced this pull request Dec 19, 2022
* Format code with prettier and gofumpt

This commit fixes the style issues introduced in 4e10e17 according to the output
from prettier and gofumpt.

Details: https://deepsource.io/gh/vdaas/vald/transform/3468f768-127e-425d-9457-42cc8d2ef2b2/

* Fix grammar (vdaas#1889)

* Fix grammar

Signed-off-by: vankichi <kyukawa315@gmail.com>

* Format code with prettier and gofumpt

* Fix grammar

Signed-off-by: vankichi <kyukawa315@gmail.com>

* Format code with prettier and gofumpt

Signed-off-by: vankichi <kyukawa315@gmail.com>
Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com>

* 💚 Separate language tool (vdaas#1890)

Signed-off-by: vankichi <kyukawa315@gmail.com>

Signed-off-by: vankichi <kyukawa315@gmail.com>

Signed-off-by: vankichi <kyukawa315@gmail.com>
Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com>
Co-authored-by: Yusuke Kato <kpango@vdaas.org>
Co-authored-by: Kiichiro YUKAWA <kyukawa315@gmail.com>
aknishid pushed a commit to aknishid/vald that referenced this pull request Dec 19, 2022
* Format code with prettier and gofumpt

This commit fixes the style issues introduced in 4e10e17 according to the output
from prettier and gofumpt.

Details: https://deepsource.io/gh/vdaas/vald/transform/3468f768-127e-425d-9457-42cc8d2ef2b2/

* Fix grammar (vdaas#1889)

* Fix grammar

Signed-off-by: vankichi <kyukawa315@gmail.com>

* Format code with prettier and gofumpt

* Fix grammar

Signed-off-by: vankichi <kyukawa315@gmail.com>

* Format code with prettier and gofumpt

Signed-off-by: vankichi <kyukawa315@gmail.com>
Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com>

* 💚 Separate language tool (vdaas#1890)

Signed-off-by: vankichi <kyukawa315@gmail.com>

Signed-off-by: vankichi <kyukawa315@gmail.com>

Signed-off-by: vankichi <kyukawa315@gmail.com>
Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com>
Co-authored-by: Yusuke Kato <kpango@vdaas.org>
Co-authored-by: Kiichiro YUKAWA <kyukawa315@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants