Skip to content
Snippets Groups Projects
Unverified Commit 1408dd16 authored by Jason Sipula's avatar Jason Sipula Committed by GitHub
Browse files

docs: workaround nested list format conflict (#30857)

parent 2e78c2c7
No related branches found
Tags 38.39.6
No related merge requests found
...@@ -7,11 +7,17 @@ Renovate can upgrade dependencies in `conanfile.txt` or `conanfile.py` files. ...@@ -7,11 +7,17 @@ Renovate can upgrade dependencies in `conanfile.txt` or `conanfile.py` files.
How it works: 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 searches in each repository for any `conanfile.txt` or `conanfile.py` file
1. Renovate extracts existing dependencies from: 1. Renovate extracts existing dependencies from:
- the `[requires]` and `[build_requires]` sections in the `conanfile.txt` format - the `[requires]` and `[build_requires]` sections in the `conanfile.txt` format
- the `requirements()` and `build_requirements()` functions in the `conanfile.py` 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 - 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. 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` 1. If Renovate finds an update, Renovate will update `conanfile.txt` or `conanfile.py`
......
...@@ -15,6 +15,11 @@ The `gleam` manager, however, uses `gleam` itself to keep `manifest.toml` up-to- ...@@ -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`: 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 --> <!-- prettier-ignore -->
1. If an existing range is a complex range (contains multiple range specifications), Renovate widens it to include the new version. 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. - Example: `>= 0.14.0 and < 0.15.0` becomes `>= 0.14.0 and < 0.16.1` for a new `0.16.0` version.
......
...@@ -2,8 +2,14 @@ ...@@ -2,8 +2,14 @@
You might be interested in the following `postUpdateOptions`: 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. `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. `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. `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 1. `gomodUpdateImportPaths` - if you'd like Renovate to update your source import paths on major updates before raising the PR
......
...@@ -16,11 +16,16 @@ ...@@ -16,11 +16,16 @@
#### Machine pre-requisites #### 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. 1. Install the `aws-cli` program on the machine.
2. Set up the environment with the `git-credentials-helper`: 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 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 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`. 3. Set the environment variable `AWS_REGION`.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment