From 01a06ec8360c54a38ea6f3ad4b62de0d876fac4f Mon Sep 17 00:00:00 2001 From: Nicklas Larsson Date: Sat, 27 Apr 2024 04:37:03 +0200 Subject: [PATCH] checks: Fix some yamllint and markdownlint errors (#3656) Fixes some pre-commit yamllint and markdownlint errors which are check by pre-commit but not by CI. --- .../create-upload-suggestions/action.yml | 5 +- .github/labeler.yml | 46 +++++++++---------- doc/development/submitting/general.md | 7 +-- 3 files changed, 31 insertions(+), 27 deletions(-) diff --git a/.github/actions/create-upload-suggestions/action.yml b/.github/actions/create-upload-suggestions/action.yml index 16f7ed4c337..7d105a5fbd4 100644 --- a/.github/actions/create-upload-suggestions/action.yml +++ b/.github/actions/create-upload-suggestions/action.yml @@ -1,3 +1,4 @@ +--- name: "Create and upload suggestions" description: "Creates a file containing changes applied by a tool" author: echoix @@ -217,7 +218,9 @@ runs: run: | { echo '' - echo 'All fixed files are included in the '"${FORMATTED_URL}"' artifact. This artifact can be downloaded and copied to the repository to replace unformatted files with the formatted files.' + echo 'All fixed files are included in the '"${FORMATTED_URL}"' artifact. \ + This artifact can be downloaded and copied to the repository to replace \ + unformatted files with the formatted files.' } >> "${GITHUB_STEP_SUMMARY}" env: FORMATTED_URL: >- diff --git a/.github/labeler.yml b/.github/labeler.yml index 2073e935f24..d6caa447e2e 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -111,24 +111,24 @@ docker: - .dockerignore docs: -- all: - - changed-files: - - any-glob-to-any-file: - - doc/** - - man/** - - '**/*.md' - - '**/*.rst' - - '**/*.html' - - '**/*.dox' - - '**/*.png' - - '**.cff' - - CITING - - CHANGES - - AUTHORS - - NEWS - - TODO - - all-globs-to-all-files: - - '!doc/development/rfc/**' + - all: + - changed-files: + - any-glob-to-any-file: + - doc/** + - man/** + - '**/*.md' + - '**/*.rst' + - '**/*.html' + - '**/*.dox' + - '**/*.png' + - '**.cff' + - CITING + - CHANGES + - AUTHORS + - NEWS + - TODO + - all-globs-to-all-files: + - '!doc/development/rfc/**' RFC: - changed-files: - any-glob-to-any-file: @@ -141,14 +141,14 @@ translation: Python: - changed-files: - any-glob-to-any-file: - - '**/*.py' - - '**/pyproject.toml' + - '**/*.py' + - '**/pyproject.toml' notebook: - changed-files: - any-glob-to-any-file: - - '**/*.ipynb' - - doc/notebooks/** - - python/grass/jupyter/** + - '**/*.ipynb' + - doc/notebooks/** + - python/grass/jupyter/** C: - changed-files: - any-glob-to-any-file: '**/*.c' diff --git a/doc/development/submitting/general.md b/doc/development/submitting/general.md index 55e6df6d2b4..48630fd3531 100644 --- a/doc/development/submitting/general.md +++ b/doc/development/submitting/general.md @@ -149,9 +149,10 @@ done manually, you can take an advantage of our [​CI](https://github.com/OSGeo Often there is more than one active release branch. You can also choose to backport only to the closest branch. If you are backporting to other release branches than -just the closets one, make sure you always backport to all the branches between "main" -and the furthest branch you are backporting to. For example, let's say we have -release branches 3.6 and 3.5, if you backport to 3.5, you should backport to 3.6, too. +just the closets one, make sure you always backport to all the branches between +"main" and the furthest branch you are backporting to. For example, let's say we +have release branches 3.6 and 3.5, if you backport to 3.5, you should backport to +3.6, too. Backport only complete fixes. When you are not sure if the fix is complete or if there is an possibility that some details such as wording will change, wait with