From 1408dd16040aebe81a23c0dcda8cfd7434360e99 Mon Sep 17 00:00:00 2001
From: Jason Sipula <SnakeDoc@users.noreply.github.com>
Date: Sun, 18 Aug 2024 01:08:57 -0700
Subject: [PATCH] docs: workaround nested list format conflict (#30857)
---
lib/modules/manager/conan/readme.md | 12 +++++++++---
lib/modules/manager/gleam/readme.md | 5 +++++
lib/modules/manager/gomod/readme.md | 8 +++++++-
lib/modules/platform/codecommit/readme.md | 11 ++++++++---
4 files changed, 29 insertions(+), 7 deletions(-)
diff --git a/lib/modules/manager/conan/readme.md b/lib/modules/manager/conan/readme.md
index 83f426db1a..2027451e03 100644
--- a/lib/modules/manager/conan/readme.md
+++ b/lib/modules/manager/conan/readme.md
@@ -7,11 +7,17 @@ Renovate can upgrade dependencies in `conanfile.txt` or `conanfile.py` files.
How it works:
+<!--
+ TODO: remove ignore
+ prettier & markdownlint conflicting nested list format
+ see: https://github.com/renovatebot/renovate/pull/30608
+-->
+<!-- prettier-ignore -->
1. Renovate searches in each repository for any `conanfile.txt` or `conanfile.py` file
1. Renovate extracts existing dependencies from:
- - the `[requires]` and `[build_requires]` sections in the `conanfile.txt` format
- - the `requirements()` and `build_requirements()` functions in the `conanfile.py` format
- - and the `python_requires`, `requires` and `build_requires` variables in the `conanfile.py` format
+ - the `[requires]` and `[build_requires]` sections in the `conanfile.txt` format
+ - the `requirements()` and `build_requirements()` functions in the `conanfile.py` format
+ - and the `python_requires`, `requires` and `build_requires` variables in the `conanfile.py` format
1. Renovate resolves the dependency's version using the Conan v2 API
1. If Renovate finds an update, Renovate will update `conanfile.txt` or `conanfile.py`
diff --git a/lib/modules/manager/gleam/readme.md b/lib/modules/manager/gleam/readme.md
index f2b86354cc..9d67e09903 100644
--- a/lib/modules/manager/gleam/readme.md
+++ b/lib/modules/manager/gleam/readme.md
@@ -15,6 +15,11 @@ The `gleam` manager, however, uses `gleam` itself to keep `manifest.toml` up-to-
Renovate's `"auto"` strategy defaults to `"widen"` and works like this for `gleam`:
+<!--
+ TODO: remove ignore
+ prettier & markdownlint conflicting nested list format
+ see: https://github.com/renovatebot/renovate/pull/30608
+-->
<!-- prettier-ignore -->
1. If an existing range is a complex range (contains multiple range specifications), Renovate widens it to include the new version.
- Example: `>= 0.14.0 and < 0.15.0` becomes `>= 0.14.0 and < 0.16.1` for a new `0.16.0` version.
diff --git a/lib/modules/manager/gomod/readme.md b/lib/modules/manager/gomod/readme.md
index c1500021a9..dd51f8c3cb 100644
--- a/lib/modules/manager/gomod/readme.md
+++ b/lib/modules/manager/gomod/readme.md
@@ -2,8 +2,14 @@
You might be interested in the following `postUpdateOptions`:
+<!--
+ TODO: remove ignore
+ prettier & markdownlint conflicting nested list format
+ see: https://github.com/renovatebot/renovate/pull/30608
+-->
+<!-- prettier-ignore -->
1. `gomodTidy` - if you'd like Renovate to run `go mod tidy` after every update before raising the PR
- 1. This is implicitly enabled for major updates if the user has enabled the option `gomodUpdateImportPaths`
+ 1. This is implicitly enabled for major updates if the user has enabled the option `gomodUpdateImportPaths`
1. `gomodTidy1.17` - if you'd like Renovate to run `go mod tidy -compat=1.17` after every update before raising the PR
1. `gomodTidyE` - if you'd like Renovate to run `go mod tidy -e` after every update before raising the PR
1. `gomodUpdateImportPaths` - if you'd like Renovate to update your source import paths on major updates before raising the PR
diff --git a/lib/modules/platform/codecommit/readme.md b/lib/modules/platform/codecommit/readme.md
index dc13d743bb..9d27ac1730 100644
--- a/lib/modules/platform/codecommit/readme.md
+++ b/lib/modules/platform/codecommit/readme.md
@@ -16,11 +16,16 @@
#### Machine pre-requisites
+<!--
+ TODO: remove ignore
+ prettier & markdownlint conflicting nested list format
+ see: https://github.com/renovatebot/renovate/pull/30608
+-->
+<!-- prettier-ignore -->
1. Install the `aws-cli` program on the machine.
2. Set up the environment with the `git-credentials-helper`:
-
- - For EC2 or Linux: [EC2 codecommit git integration](https://aws.amazon.com/premiumsupport/knowledge-center/codecommit-git-repositories-ec2/).
- - For Windows: [windows codecommit git integration](https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-https-windows.html).
+ - For EC2 or Linux: [EC2 codecommit git integration](https://aws.amazon.com/premiumsupport/knowledge-center/codecommit-git-repositories-ec2/).
+ - For Windows: [windows codecommit git integration](https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-https-windows.html).
3. Set the environment variable `AWS_REGION`.
--
GitLab