docs(core/config): Experimental feature handling #16183
Conversation
|
Generated docs - Docs diff - |
Co-authored-by: Michael Kriese <michael.kriese@visualon.de>
|
Updated to the latest commit: |
i dont quite follow, what do you mean exactly ? i didnt merge anything in this PR 😶 |
|
sorry, the GitHub app showed wrong stuff |
- index markdown
Gabriel-Ladzaretti
force-pushed
the
14427-Experimental-feature-handling
branch
from
2e01980
to
4855e01
Compare
viceice
changed the title
tools/docs/config.ts
Outdated
| let optionName = ''; | ||
| let start = 0; | ||
| for (const [i, line] of lines.entries()) { | ||
| if (line.startsWith('##')) { |
There was a problem hiding this comment.
| if (line.startsWith('##')) { | |
| if (line.startsWith('## ') || line.startsWith('### ')) { |
We've also ####, which aren't options but sub header. Not sure if we should render the warning before or after those 🤔
@rarkins WDYT?
renovate/docs/usage/configuration-options.md
Line 2368 in 8ce5436
tools/docs/config.ts
Outdated
| headerIndex = configOptionsRaw.indexOf(`### ${option.name}`); | ||
|
|
||
| if (!indexed[option.name]) { | ||
| return; |
There was a problem hiding this comment.
This is an error, docs should fail, so log an error and throw to abort
There was a problem hiding this comment.
this happens quite a lot, options from lib/config/options/index.ts contains config options from both self-hosted-configuration.md and configuration-options.md and we are doing one file at a time.
There was a problem hiding this comment.
Then we should check the globalOnly flag. Value should match bot variable.
There was a problem hiding this comment.
so now it seems that options also includes keys from renovate-schema.json.
guess we cant throw here.
Complete list of such values
ansible
ansible-galaxy
argocd
autodiscover
autodiscoverFilter
azure-pipelines
baseDir
batect
batect-wrapper
bazel
bazelisk
bitbucket-pipelines
buildkite
bundler
cake
cargo
cdnurl
circleci
cloudbuild
cocoapods
composer
conan
deps-edn
docker-compose
dockerfile
droneci
flux
forceCli
fvm
git-submodules
github-actions
gitlabci
gitlabci-include
gomod
gradle
gradle-wrapper
helm-requirements
helm-values
helmfile
helmsman
helmv3
homebrew
html
jenkins
jsonnet-bundler
kubernetes
kustomize
leiningen
logFile
logFileLevel
maven
meteor
mix
nodenv
npm
nuget
nvm
pip-compile
pip_requirements
pip_setup
pipenv
poetry
prCommitsPerRunLimit
pre-commit
pub
pyenv
redisUrl
regex
repositories
ruby-version
sbt
setup-cfg
swift
terraform
terraform-version
terragrunt
terragrunt-version
travis
velaci
There was a problem hiding this comment.
don't they have a header in one of the docs?
There was a problem hiding this comment.
some do but not in self-hosted-configuration.md or configuration-options.md like managers. others have none, e.g. .bitbucket-pipelines
There was a problem hiding this comment.
So our tests are wrong, every option should have a corresponding entry 🤔
There was a problem hiding this comment.
So our tests are wrong, every option should have a corresponding entry
i think we are good now, every option has an entry in self-hosted-configuration.md or configuration-options.md, otherwise its a manager that should have its own readme file which is covered by lib/modules/manager/metadata.spec.ts.
|
classified as docs, because no runtime change for renovate, so no relerase required 😉 |
Co-authored-by: Michael Kriese <michael.kriese@visualon.de> Co-authored-by: Rhys Arkins <rhys@arkins.net>
|
btw: you should also remove
|
|
Blocked by - |
Gabriel-Ladzaretti
added
the
status:blocked
# Conflicts: # test/website-docs.spec.ts
Gabriel-Ladzaretti
removed
the
status:blocked
Co-authored-by: Michael Kriese <michael.kriese@visualon.de>
|
🎉 This PR is included in version 32.98.1 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
Changes
Add experimental entry to
RenovateOptionBase.Context
Closes #14427
Documentation (please check one with an [x])
How I've tested my work (please tick one)
I have verified these changes via: