vale: a horrible workaround to pass config

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2022-04-27 20:06:14 +02:00
parent 42713e9c01
commit edc718e2de
2 changed files with 12 additions and 9 deletions
+7 -7
View File
@@ -14,16 +14,16 @@ jobs:
- uses: actions/checkout@v2
# Vale does not support file excludes, so we use the script to generate a list of files instead
- name: list files to check
id: list
run: echo "::set-output name=files::$(node scripts/check-docs-quality.js --list)"
# The action also does not allow args or a local config file to be passed in, so the files array
# also contains an "--config=.github/vale/config.ini" option
- name: generate vale args
id: generate-args
run: echo "::set-output name=args::$(node scripts/check-docs-quality.js --ci-args)"
- name: documentation quality check
uses: errata-ai/vale-action@v1.5.0
# Whitelist excluding ADOPTERS, CHANGELOG and OWNERS (no exclude flag exists)
with:
# TODO: Update once this is in master
config: https://raw.githubusercontent.com/backstage/backstage/f91974260b7849cd1cf4c7629fc3310f678b0f29/.github/vale/config.ini
files: '${{ steps.list.files }}'
# This also contains --config=.github/vale/config.ini ... :/
files: '${{ steps.generate-args.args }}'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+5 -2
View File
@@ -95,8 +95,11 @@ async function runVale(files) {
async function main() {
const files = await listFiles();
if (process.argv.includes('--list')) {
process.stdout.write(JSON.stringify(files));
if (process.argv.includes('--ci-args')) {
process.stdout.write(
// Workaround for not being able to pass arguments to the vale action
JSON.stringify(['--config=.github/vale/config.ini', ...files]),
);
return;
}