From b1ed0ebe2971709864273bbefebb321b440f7739 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= Date: Tue, 16 Jan 2024 14:24:07 +0100 Subject: [PATCH] bump to vale 3 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fredrik Adelöw --- .../vale/{Vocab => config/vocabularies}/Backstage/accept.txt | 0 .github/workflows/verify_docs-quality.yml | 2 +- CONTRIBUTING.md | 2 +- scripts/check-docs-quality.js | 4 ++-- 4 files changed, 4 insertions(+), 4 deletions(-) rename .github/vale/{Vocab => config/vocabularies}/Backstage/accept.txt (100%) diff --git a/.github/vale/Vocab/Backstage/accept.txt b/.github/vale/config/vocabularies/Backstage/accept.txt similarity index 100% rename from .github/vale/Vocab/Backstage/accept.txt rename to .github/vale/config/vocabularies/Backstage/accept.txt diff --git a/.github/workflows/verify_docs-quality.yml b/.github/workflows/verify_docs-quality.yml index 8e3b333dd3..d4b83ccefc 100644 --- a/.github/workflows/verify_docs-quality.yml +++ b/.github/workflows/verify_docs-quality.yml @@ -30,6 +30,6 @@ jobs: with: # This also contains --config=.github/vale/config.ini ... :/ files: '${{ steps.generate.outputs.args }}' - version: 2.30.0 # TODO: migrate to v3 + version: latest env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 527957677b..be88ed2249 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -386,7 +386,7 @@ Here are a few things that can help as you go through the review process: - PRs get automatically assigned so you don't need to ping people, they will be notified and have a process of their own for this - If you are waiting for a review or mid-review and your PR goes stale one of the easiest ways to clear the stale bot is by simply rebasing your PR - There are times where you might run into conflict with the `yarn.lock` during a rebase, to help with that make sure your `master` branch is up to date and then in your branch run `git checkout master yarn.lock` and then run `yarn install`, this will get you a conflict free `yarn.lock` file you can commit -- If Vale finds issues with your documentation but it's a code reference you can fix it by putting backticks (`) around it. Now if it is a special word or maybe a name there are two ways you can fix that by adding it to the list of accepted words in the [accept.txt file](https://github.com/backstage/backstage/blob/master/.github/vale/Vocab/Backstage/accept.txt) and them committing that change +- If Vale finds issues with your documentation but it's a code reference you can fix it by putting backticks (`) around it. Now if it is a special word or maybe a name there are two ways you can fix that by adding it to the list of accepted words in the [accept.txt file](https://github.com/backstage/backstage/blob/master/.github/vale/config/vocabularies/Backstage/accept.txt) and them committing that change ### Merging to Master diff --git a/scripts/check-docs-quality.js b/scripts/check-docs-quality.js index d3b51a49a3..7960ff72bb 100755 --- a/scripts/check-docs-quality.js +++ b/scripts/check-docs-quality.js @@ -70,7 +70,7 @@ async function exitIfMissingVale() { process.exit(1); } console.log(`Language linter (vale) generated errors. Please check the errors and review any markdown files that you changed. - Possibly update .github/vale/Vocab/Backstage/accept.txt to add new valid words.\n`); + Possibly update .github/vale/config/vocabularies/Backstage/accept.txt to add new valid words.\n`); process.exit(0); } } @@ -89,7 +89,7 @@ async function runVale(files) { // If it contains system level error. In this case vale does not exist. if (process.platform !== 'win32' || result.error) { console.log(`Language linter (vale) generated errors. Please check the errors and review any markdown files that you changed. - Possibly update .github/vale/Vocab/Backstage/accept.txt to add new valid words.\n`); + Possibly update .github/vale/config/vocabularies/Backstage/accept.txt to add new valid words.\n`); } return false; }