docs(azure): update azuredevops docs to match new changes #33788
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mathisgauthey
changed the title
rarkins
reviewed
Jan 23, 2025
lib/modules/platform/azure/readme.md
Outdated
| { | ||
| "platform": "azure", | ||
| "endpoint": "https://dev.azure.com/ORG_NAME", | ||
| "token": "process.env.RENOVATE_TOKEN", |
There was a problem hiding this comment.
JSON files cannot read from process.env. This example would put the literal string value "process.env.RENOVATE_TOKEN" into the file, and not the value from env. Same as for the hostRules below
There was a problem hiding this comment.
Hey @rarkins , it works on our on-prem azuredevops server.
Would it then works just because I'm calling npx renovate with these env vars ?
RENOVATE_PLATFORM: azure
RENOVATE_ENDPOINT: $(System.CollectionUri)
RENOVATE_CONFIG_FILE: $(Build.SourcesDirectory)/renovate_bot_config.json
RENOVATE_TOKEN: $(System.AccessToken)
LOG_LEVEL: debug
There was a problem hiding this comment.
Probably. If you define things like token in both file and env, env wins. So the "wrong" value for token above would be overridden by the RENOVATE_TOKEN env
There was a problem hiding this comment.
I updated it.
As seen in PR renovatebot#33788 discussion
HonkingGoose
suggested changes
Jan 24, 2025
| - bash: | | ||
| add-apt-repository ppa:git-core/ppa | ||
| apt update && apt install git -y | ||
| displayName: 'Install latest git version' |
There was a problem hiding this comment.
Suggested change
| displayName: 'Install latest git version' | |
| displayName: 'Install latest version of Git' |
Are you allowed to use capitalization in the displayName field/variable?
|
|
||
| <!-- prettier-ignore --> | ||
| !!! info | ||
| Renovate bot is now using the set of APIs that azure provides to query the azure-pipelines tasks versions directly from the instance. ([PR #32966](https://github.com/renovatebot/renovate/pull/32966) and [Discussion #24820](https://github.com/renovatebot/renovate/discussions/24820)) |
There was a problem hiding this comment.
Suggested change
| Renovate bot is now using the set of APIs that azure provides to query the azure-pipelines tasks versions directly from the instance. ([PR #32966](https://github.com/renovatebot/renovate/pull/32966) and [Discussion #24820](https://github.com/renovatebot/renovate/discussions/24820)) | |
| Renovate now uses the set of APIs that Azure provides to query the azure-pipelines tasks versions directly from the instance. Read [pull request #32966](https://github.com/renovatebot/renovate/pull/32966) and [discussion #24820](https://github.com/renovatebot/renovate/discussions/24820) for more background information on this change. |
| !!! info | ||
| Renovate bot is now using the set of APIs that azure provides to query the azure-pipelines tasks versions directly from the instance. ([PR #32966](https://github.com/renovatebot/renovate/pull/32966) and [Discussion #24820](https://github.com/renovatebot/renovate/discussions/24820)) | ||
|
|
||
| To use it, you need to have in your config : |
There was a problem hiding this comment.
Suggested change
| To use it, you need to have in your config : | |
| To let Renovate use the Azure DevOps internal API, you must set these variables in your config: |
| To use it, you need to have in your config : | ||
|
|
||
| - `platform` = `azure` | ||
| - `endpoint` = `$(System.CollectionUri)` (an [azure predefined variable](https://learn.microsoft.com/en-us/azure/devops/pipelines/build/variables?view=azure-devops&tabs=yaml)) |
There was a problem hiding this comment.
Suggested change
| - `endpoint` = `$(System.CollectionUri)` (an [azure predefined variable](https://learn.microsoft.com/en-us/azure/devops/pipelines/build/variables?view=azure-devops&tabs=yaml)) | |
| - `endpoint` = `$(System.CollectionUri)`, this is an [Azure predefined variable](https://learn.microsoft.com/en-us/azure/devops/pipelines/build/variables?view=azure-devops&tabs=yaml) |
Comment on lines
+113
to
+114
| An example configuration file, in `.json` format this time, would be : | ||
|
|
There was a problem hiding this comment.
Suggested change
| An example configuration file, in `.json` format this time, would be : |
Let's use a codeblock title instead of this line. 😉
|
|
||
| An example configuration file, in `.json` format this time, would be : | ||
|
|
||
| ```json |
There was a problem hiding this comment.
Suggested change
| ```json | |
| ```json title="Example config file in JSON format" |
rarkins
reviewed
Jan 24, 2025
| "packageRules": [ | ||
| { | ||
| "matchDatasources": ["azure-pipelines-tasks"], | ||
| "extractVersion": "^(?<version>\\d+)" |
There was a problem hiding this comment.
What's the reason for this? Are there some characters after which need ignoring?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
I wanted to add examples so that new users will benefit from the recent changes related to how renovate picks up tasks version using internal APIs when
azure-pipelinesis enabled in renovate configuration.Context
Documentation (please check one with an [x])
How I've tested my work (please select one)
I have verified these changes via:
pnpm docs:buildandpnpm mkdocs serveto preview the documentation changes.Why another PR ?
I made a mistake with my previous PR by committing with the wrong mail, hence the CLA validation did not seem to work fine.
Sorry for the inconvenience.