Commit Graph

61 Commits

Author SHA1 Message Date
Kyle Welch 3228cc72b4 docs: document GitLab auth for private Go modules (#44371)
Private GitLab projects need a `hostType: "go"` host rule with a username and password so Renovate can authenticate the go-get request it uses to resolve a module's source repository. Without it GitLab returns a truncated go-import path for the unauthenticated request and the version lookup 404s.

Came up in discussion #37624 after the resolution change in #36963.
2026-09-03 11:18:15 +00:00
Jamie Tanna b62fe59594 fix: remove references to "bot" (#39305)
We dropped the "bot" from our terminology long ago, but it looks like
we've got some outdated docs + code that reference it.

We should remove this to keep things consistent.

A `fix`, as we're changing the commit author's name, and log lines.

Co-authored-by: Claude Sonnet 5 <jamie.tanna+claude-code@mend.io>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
2026-09-02 08:56:20 +00:00
Pieter Willekens e0c13b6c57 feat(manager/npm): read private registries from pnpm-workspace.yaml (#44083)
* feat(manager/npm): read private registries from pnpm-workspace.yaml

Honor the `registry` and `registries` settings (pnpm v11+) declared in pnpm-workspace.yaml, applying them to workspace catalog/override deps and member package.json deps. Registry values containing ${...} are ignored, matching pnpm v11.5.3+.

* refactor(manager/npm): share pnpm registry resolution across extract paths

Extract a single applyPnpmWorkspaceRegistries helper so both the
pnpm-workspace catalog path and the package.json extract path apply
registries through one chokepoint, with env-var registry URLs filtered
once and consistently.

* refactor(manager/npm): filter pnpm env-var registries in schema

Move the env-var registry filtering into the PnpmWorkspaceFile schema as a
transform so registries are filtered once at parse time, and use the Nullish
helper for the registry/registries fields.

* refactor(manager/npm): simplify pnpm-workspace check and log parse errors
2026-07-17 11:56:13 +00:00
Jamie Tanna 128f446e08 docs: ensure that config in documentation is error and warning free (#43727)
* docs: skip validation on JSON files that aren't Renovate config

As part of future changes, we'll enable validation on all JSON code
snippets to run Config Validation.

Before we do that, we should opt-out JSON snippets that aren't anything
related to Renovate config.

* docs: don't validate invalid Renovate config

As it's intentionally referencing a manager that doesn't exist.

* docs: don't validate partial Renovate config

As part of future changes, we'll enable validation on all JSON code
snippets to run Config Validation.

There are several code snippets we have that are part of a Renovate JSON,
but it doesn't make sense to convert these to a fully passing config, as
it'd reduce clarity on what we're trying to explain.

* docs: convert `baseBranchPatterns` snippets to code blocks

So we can validate them.

* docs: make sure that `datasourceTemplate` is set

So this passes validation.

* docs: clarify that `force` is global config

As it may not be clear, so we can make it extra clear with a `.js` file,
and note that it's global self-hosted config.

* docs: make sure `packageRules` is an array

* docs: `matchBaseBranches` needs `baseBranchPatterns` to be set

* docs: correct typo for `prBodyColumns`

* docs: mark global config snippets as such

As part of future changes, we'll use this to detect whether it's global
self-hosted configuration.

* docs: make sure `packageRules` wraps its children

* docs: add `allowedHeaders`

* docs: ignore deprecation warnings

As part of future changes, we'll use this to note that we don't care
about the validation warnings.

* docs: make sure `customManagers` wraps its children

* docs: make sure `fleet` wraps its children

* docs: validate JSON snippets are valid Renovate config

To make sure that we're always presenting valid JSON configuration to
our users, we can validate them as part of `check-fenced-code`.

As well as configuration errors we can warn for warnings, but allow code
blocks to opt-out, for instance when there's a known deprecation
affecting the code block.

We need to make sure to set `allowedEnv` for various code snippets that
reference environment variables.

* docs(development): document fenced code block checks

* docs: wrap `configType` and `ignoreConfigWarnings` in `{ ... }`

As otherwise we see build failures i.e.

    WARNING -  Doc file 'modules/platform/gitlab/index.md' contains a link
       '../../../self-hosted-configuration.md#autodiscoverrepoorder', but the doc
       'self-hosted-configuration.md' does not contain an anchor '#autodiscoverrepoorder'.

This needs to be wrapped alongside all other options like `title`.

* fixup! docs: wrap `configType` and `ignoreConfigWarnings` in `{ ... }`
2026-06-02 13:29:48 +00:00
Sebastian Poxhofer 9a27d7aa78 ci(prettier): add prettier plugin for admonitions (#43615)
* ci: add local mkdocs-admonitions plugin for prettier to allow admonition preservation

* docs: remove uses of `prettier-ignore` for admonitions

* test: rather use await expect

* chore: use named group exclusively
2026-05-27 09:39:52 +00:00
Jamie Tanna 4b0146ab7b docs: use 2-space indentation for Markdown (#43537)
As noted in #39090, MkDocs requires 4 spaces for indentation (in
particular, for nested lists) whereas our Prettier/markdownlint
configuration expects 2 spaces.

This means that when trying to use i.e. nested lists, we need to ignore
prettier and markdownlint, otherwise it fails.

To handle this, we can add a Markdown hook to override the indentation
level to 2 spaces.

This also requires we update:

- admonitions
- indented text in `index.md`

Co-authored-by: Claude Sonnet 4.6 <jamie.tanna+claude-code@mend.io>
2026-05-26 09:05:42 +00:00
Anne Stellingwerf 9ef9ee5a9d fix(tools): correct migration validation logic in check-fenced-code.ts (#38936) 2025-10-29 17:23:04 +00:00
Anne Stellingwerf 9fae0192a1 docs: introduce JSON schema validation and migration checks (#38145)
* docs: introduce JSON schema validation and migration checks

* refactor(tools): enhance code clarity with additional typings, comments, and optional chaining

* ci(workflows): add build steps to lint and type-check jobs

* Update tools/check-fenced-code.mjs

Co-authored-by: RahulGautamSingh <rahultesnik@gmail.com>

* Partial revert

* docs(jsonata): fix wording in code block title in readme

* ci(workflows): remove redundant build steps from workflows

* ci(workflows): remove redundant build steps from workflows

* refactor(tools): simplify error reporting

* Incorporate feedback

* Incorporate feedback

* Incorporate feedback

---------

Co-authored-by: RahulGautamSingh <rahultesnik@gmail.com>
Co-authored-by: Jamie Tanna <jamie.tanna@mend.io>
2025-10-07 10:54:48 +00:00
RahulGautamSingh bc7d0595d0 feat(config): managerFilePatterns (#34615)
Co-authored-by: Sebastian Poxhofer <secustor@users.noreply.github.com>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: Michael Kriese <michael.kriese@visualon.de>
Co-authored-by: Rhys Arkins <rhys@arkins.net>
2025-05-04 08:30:24 +00:00
Sebastian Poxhofer 78002a0993 feat: add RENOVATE_ prefix to Github com token and env host rules (#34568) 2025-03-05 12:54:30 +00:00
jmsmtn dd2c2e622d fix(docs): typos (#32888) 2024-12-04 21:43:19 +00:00
Meysam 1e4134fd3a fix(docs): typo (#32821) 2024-11-30 09:51:04 +00:00
Justin Clareburt c80a052956 docs: add documentation for the Developer Portal host rules credentials (#32542)
Co-authored-by: Justin Clareburt <justinclareburt@gmail.com>
Co-authored-by: Rhys Arkins <rhys@arkins.net>
2024-11-19 13:47:58 +00:00
Justin Clareburt c1fe7922ea docs: create sidebar entries for Mend-hosted app secrets pages (#30718)
Co-authored-by: Rhys Arkins <rhys@arkins.net>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
2024-08-18 10:52:20 +00:00
Justin Clareburt 7ccebccbe3 docs: added docs for migrating encrypted secrets (#30132)
Co-authored-by: Rhys Arkins <rhys@arkins.net>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
2024-07-20 17:00:48 +00:00
HonkingGoose c8872ed747 docs(private packages): rewrite pip-compile section (#29725) 2024-06-17 15:38:26 +00:00
Craig de Stigter da580ad000 docs(pip-compile): Add note re proper usage of index-url (#29421) 2024-06-05 05:35:35 +00:00
Michael Kriese 60ceb65cca docs: validate relative links (#28690)
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
2024-04-30 10:56:15 +00:00
Miles Budnek 66dc246133 feat(manager/pip-compile): Use python keychain module for credentials (#27342) 2024-02-22 04:11:52 +00:00
Oleksandr Redko 1ffa44c4fe docs: fix typos and improve documentation consistency (#27418) 2024-02-19 12:36:39 +00:00
Miles Budnek c3e57e7b51 feat(manager/pip-compile): Add support for non-default package repos to the pip-compile manager (#26853)
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
2024-02-12 17:25:14 +00:00
Richard Sahrakorpi 88daaf5a89 feat(npm): fuzzy merge registries in .yarnrc.yml (#26922)
Co-authored-by: Rhys Arkins <rhys@arkins.net>
2024-01-30 08:21:14 +00:00
Maksym Romanowski 84019435ba feat(pipenv): add support for auth (#24581)
Co-authored-by: Rhys Arkins <rhys@arkins.net>
Co-authored-by: Michael Kriese <michael.kriese@visualon.de>
2023-11-14 10:40:17 +00:00
Ілля Мазуряк f70f0c82be feat(changelogs): Migrate fetchReleaseNotes to fetchChangeLogs (#25364)
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: Rhys Arkins <rhys@arkins.net>
2023-11-05 18:32:59 +00:00
HonkingGoose b58322920c docs: use titles for more code blocks (#25526) 2023-11-02 16:04:33 +00:00
Rhys Arkins b21827dac8 feat(github): set package registry credentials automatically (#25214)
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
2023-10-17 06:58:08 +00:00
HonkingGoose 124c1e636c docs: refer to the app as the Mend Renovate app (#23336)
Co-authored-by: Rhys Arkins <rhys@arkins.net>
2023-07-13 14:24:43 +00:00
HonkingGoose 0551a12f60 docs(private package support): monospace github.com URL (#23107) 2023-07-03 14:11:50 +00:00
HonkingGoose 71d082d16f docs: use relative URLs in more places (#22516) 2023-05-31 15:52:30 +00:00
HonkingGoose b08fa0cf8b docs: drop weasel words (#22165)
Co-authored-by: Rhys Arkins <rhys@arkins.net>
2023-05-29 08:20:40 +00:00
HonkingGoose da1eeea02b docs: replace unencrypted with plaintext (#20849) 2023-03-10 17:24:35 +01:00
Ville Skyttä fce494db21 docs: spelling and grammar fixes (#20443) 2023-02-16 06:35:19 +00:00
Simon Podlipsky e1cbd3f70f docs: add snippet on how to auth maven with gitlab pipelines (#20089)
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
2023-01-30 07:16:02 +01:00
Eric Durand-Tremblay e8a5437cd3 feat(manager/composer): support git-tags hostRules for github.com when updating artifacts (#18004)
Co-authored-by: Rhys Arkins <rhys@arkins.net>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
fixes undefined
2023-01-13 13:33:49 +00:00
HonkingGoose 73cac44d2c docs(python): rewrite page (#16465)
Co-authored-by: Rhys Arkins <rhys@arkins.net>
2022-12-17 16:37:51 +01:00
HonkingGoose a49e206dd3 docs: use input-neutral verbs (#19165) 2022-11-30 10:37:00 +01:00
Rhys Arkins fc605a59c0 fix(composer): Revert "feat(manager/composer): support git-tags hostRules for github.com when updating artifacts" (#17961) 2022-09-25 07:06:44 +03:00
Eric Durand-Tremblay 781b8fbcb7 feat(manager/composer): support git-tags hostRules for github.com when updating artifacts (#16193) 2022-08-30 16:49:01 +03:00
Michael Kriese 6dd4ea3c74 feat(github): use repo url to get token (#17179) 2022-08-29 07:37:45 +00:00
Philip 1c81eaf24d fix(datasource/metadata): delete homepage url case (#17372)
Co-authored-by: whitesource-for-github-com[bot] <50673670+whitesource-for-github-com[bot]@users.noreply.github.com>
Co-authored-by: whitesource-for-github-com[bot] <whitesource-for-github-com[bot]@users.noreply.github.com>
Co-authored-by: hasanwhitesource <hasan.awad@whitesourcesoftware.com>
Co-authored-by: Hasan Awad <90554456+hasanwhitesource@users.noreply.github.com>
Co-authored-by: Nabeel Saabna <48175656+nabeelsaabna@users.noreply.github.com>
Co-authored-by: Michael Kriese <michael.kriese@visualon.de>
2022-08-25 17:18:51 +00:00
Philip 8f54847e0a docs: Update private-packages.md nuget section (#16942) 2022-08-12 07:57:11 +03:00
HonkingGoose 5f21c63ba5 docs: replace word therefore, plus other small changes (#15694) 2022-06-02 16:58:52 +02:00
Rhys Arkins afd96e7b8a fix: whitesource -> mend (#15729) 2022-05-25 15:23:28 +02:00
HonkingGoose 41fd7fbf46 docs: replace however with but (#14707)
Co-authored-by: Anne Stellingwerf <astellin@opentext.com>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: Rhys Arkins <rhys@arkins.net>
2022-03-28 19:25:49 +00:00
HonkingGoose 315f4f689a docs: replace attempt with try (#14689) 2022-03-16 14:54:30 +01:00
HonkingGoose 5a52b04c96 docs: replace contain(s) with has or have (#14692) 2022-03-16 14:50:20 +01:00
Rhys Arkins b7eab64efb feat(config): deprecate non-default npm presets (#14444)
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
2022-02-28 15:14:58 +01:00
Florian Greinacher 4314bb8060 fix(manager/poetry): prioritize datasource-scoped credentials when authenticating with poetry sources (#14255)
* feat: use private gitlab pypi registry together with gitlab host

* docs: slim down documentation a bit

* fix: correctly normalize source name

* fix: correctly handle fallback

* refactor: apply review suggestions

* Update docs/usage/getting-started/private-packages.md

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

* Update docs/usage/getting-started/private-packages.md

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

Co-authored-by: Marion Deveaud <marion.deveaud@siemens.com>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
2022-02-16 21:54:06 +01:00
HonkingGoose 2dc8ebb2e8 docs(private package support): use admonitions (#13887) 2022-01-28 19:38:44 +01:00
renovate[bot] b7dff549ab chore(deps): update dependency markdownlint-cli2 to v0.4.0 (#13613)
Co-authored-by: Renovate Bot <bot@renovateapp.com>
Co-authored-by: Rhys Arkins <rhys@arkins.net>
Co-authored-by: Michael Kriese <michael.kriese@visualon.de>
2022-01-18 13:59:55 +00:00