From 38fc1d72650a9f568b4c21d153443252cfe6c51d Mon Sep 17 00:00:00 2001 From: chadcarlson Date: Mon, 12 Feb 2024 13:34:52 -0500 Subject: [PATCH 1/2] Fix Vale errors on CLI generated pages. --- .../{Vocab => config/vocabularies}/Platform/accept.txt | 9 +++------ .../{Vocab => config/vocabularies}/Platform/reject.txt | 0 shared/scripts/gen-cli-docs.sh | 4 +++- sites/friday/src/administration/cli/reference.md | 6 +++++- sites/platform/src/administration/cli/reference.md | 6 +++++- 5 files changed, 16 insertions(+), 9 deletions(-) rename contributing/styles/{Vocab => config/vocabularies}/Platform/accept.txt (97%) rename contributing/styles/{Vocab => config/vocabularies}/Platform/reject.txt (100%) diff --git a/contributing/styles/Vocab/Platform/accept.txt b/contributing/styles/config/vocabularies/Platform/accept.txt similarity index 97% rename from contributing/styles/Vocab/Platform/accept.txt rename to contributing/styles/config/vocabularies/Platform/accept.txt index 4841e1680d..46ca238466 100644 --- a/contributing/styles/Vocab/Platform/accept.txt +++ b/contributing/styles/config/vocabularies/Platform/accept.txt @@ -69,8 +69,7 @@ IPs? JVM imagetragick jpegoptim -Kafka -kafka +[Kk]afka Lando Laravel Loggly @@ -155,8 +154,7 @@ scp seccomp serverless Servlet -sftp -SFTP +[Ss][Ff][Tt][Pp] shard shortcode Slowloris @@ -168,8 +166,7 @@ Strapi [Ss]ubprocessor subuser Swoole -Symfony -symfony +[Ss]ymfony [Ss]yslog systemd Thorntail diff --git a/contributing/styles/Vocab/Platform/reject.txt b/contributing/styles/config/vocabularies/Platform/reject.txt similarity index 100% rename from contributing/styles/Vocab/Platform/reject.txt rename to contributing/styles/config/vocabularies/Platform/reject.txt diff --git a/shared/scripts/gen-cli-docs.sh b/shared/scripts/gen-cli-docs.sh index 67eb494d35..34af80afc6 100755 --- a/shared/scripts/gen-cli-docs.sh +++ b/shared/scripts/gen-cli-docs.sh @@ -3,13 +3,15 @@ cp shared/pages/commands.md $1 VERSION=$($2 version) + +printf "\n\n" >> $1 + printf "\n# $VERSION\n" >> $1 printf "\n- [Installation](/administration/cli#1-install)" >> $1 printf "\n- [Open an issue](https://github.com/platformsh/cli/issues)\n" >> $1 printf "\n## All commands\n" >> $1 -printf "\n\n" >> $1 $2 list --format=md | tail -n +2 >> $1 diff --git a/sites/friday/src/administration/cli/reference.md b/sites/friday/src/administration/cli/reference.md index ec80147973..c7b5769f60 100644 --- a/sites/friday/src/administration/cli/reference.md +++ b/sites/friday/src/administration/cli/reference.md @@ -11,7 +11,9 @@ showTitle: false } -# Upsun CLI 5.0.8 + + +# Upsun CLI 5.0.9 - [Installation](/administration/cli#1-install) - [Open an issue](https://github.com/platformsh/cli/issues) @@ -8469,3 +8471,5 @@ upsun workers [--refresh] [--pipe] [-p|--project PROJECT] [-e|--environment ENVI Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: UPSUN_CLI_NO_INTERACTION=1 + + diff --git a/sites/platform/src/administration/cli/reference.md b/sites/platform/src/administration/cli/reference.md index da35c3013f..9d492eda80 100644 --- a/sites/platform/src/administration/cli/reference.md +++ b/sites/platform/src/administration/cli/reference.md @@ -11,7 +11,9 @@ showTitle: false } -# Platform.sh CLI 5.0.8 + + +# Platform.sh CLI 5.0.9 - [Installation](/administration/cli#1-install) - [Open an issue](https://github.com/platformsh/cli/issues) @@ -8421,3 +8423,5 @@ platform workers [--refresh] [--pipe] [-p|--project PROJECT] [-e|--environment E Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: PLATFORMSH_CLI_NO_INTERACTION=1 + + From c55bb5d2fee037578cf0c0248e13ad1f41474792 Mon Sep 17 00:00:00 2001 From: chadcarlson Date: Mon, 12 Feb 2024 13:37:12 -0500 Subject: [PATCH 2/2] Bump Vale version. --- .github/workflows/linting.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/linting.yaml b/.github/workflows/linting.yaml index c8ca64d4da..2fb604ae2a 100644 --- a/.github/workflows/linting.yaml +++ b/.github/workflows/linting.yaml @@ -47,7 +47,7 @@ jobs: - name: Vale uses: errata-ai/vale-action@reviewdog with: - version: 2.30.0 + version: 3.0.7 fail_on_error: true reporter: github-check files: sites/platform/src