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

Fix Vale errors on CLI generated pages. #3754

Merged
merged 2 commits into from
Feb 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/linting.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,7 @@ IPs?
JVM
imagetragick
jpegoptim
Kafka
kafka
[Kk]afka
Lando
Laravel
Loggly
Expand Down Expand Up @@ -155,8 +154,7 @@ scp
seccomp
serverless
Servlet
sftp
SFTP
[Ss][Ff][Tt][Pp]
shard
shortcode
Slowloris
Expand All @@ -168,8 +166,7 @@ Strapi
[Ss]ubprocessor
subuser
Swoole
Symfony
symfony
[Ss]ymfony
[Ss]yslog
systemd
Thorntail
Expand Down
4 changes: 3 additions & 1 deletion shared/scripts/gen-cli-docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,15 @@
cp shared/pages/commands.md $1

VERSION=$($2 version)

printf "\n<!-- vale off -->\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<!-- vale off -->\n" >> $1

$2 list --format=md | tail -n +2 >> $1

Expand Down
6 changes: 5 additions & 1 deletion sites/friday/src/administration/cli/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ showTitle: false
}
</style>

# Upsun CLI 5.0.8
<!-- vale off -->

# Upsun CLI 5.0.9

- [Installation](/administration/cli#1-install)
- [Open an issue](https://github.com/platformsh/cli/issues)
Expand Down Expand Up @@ -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



<!-- vale on -->
6 changes: 5 additions & 1 deletion sites/platform/src/administration/cli/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@
}
</style>

# Platform.sh CLI 5.0.8
<!-- vale off -->

Check failure on line 14 in sites/platform/src/administration/cli/reference.md

View workflow job for this annotation

GitHub Actions / vale

[vale] sites/platform/src/administration/cli/reference.md#L14

[Vale.Avoid] Avoid using 'Platform.sh'.
Raw output
{"message": "[Vale.Avoid] Avoid using 'Platform.sh'.", "location": {"path": "sites/platform/src/administration/cli/reference.md", "range": {"start": {"line": 14, "column": 3}}}, "severity": "ERROR"}

# Platform.sh CLI 5.0.9

- [Installation](/administration/cli#1-install)
- [Open an issue](https://github.com/platformsh/cli/issues)
Expand Down Expand Up @@ -8421,3 +8423,5 @@
Do not ask any interactive questions; accept default values. Equivalent to using the environment variable: PLATFORMSH_CLI_NO_INTERACTION=1



<!-- vale on -->
Loading