Skip to content

Commit

Permalink
📝 Document Renovate dependency upgrade checking mecanism
Browse files Browse the repository at this point in the history
  • Loading branch information
anthonyroussel authored and dbouron committed May 20, 2022
1 parent 0ddcb01 commit 69bf715
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 3 deletions.
10 changes: 8 additions & 2 deletions .github/renovate.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,14 @@
"extends": [
"config:base"
],
"labels": [
"prConcurrentLimit": 2,
"addLabels": [
"dependencies"
],
"dependencyDashboardLabels": [
"dependencies"
],
"commitMessageAction": "⬆️ Update",
"regexManagers": [
{
"fileMatch": [
Expand All @@ -14,7 +19,8 @@
"matchStrings": [
"# renovate: datasource=(?<datasource>[a-z-]+?) depName=(?<depName>[^\\s]+?)( packageName=(?<packageName>.*?))?( extractVersionTemplate=(?<extractVersionTemplate>.*?))?\\s[a-zA-Z_]+?=(?<currentValue>.+?)\\s"
],
"extractVersionTemplate": "{{#if extractVersionTemplate}}{{{extractVersionTemplate}}}{{else}}^v(?<version>.*)${{/if}}"
"extractVersionTemplate": "{{#if extractVersionTemplate}}{{{extractVersionTemplate}}}{{else}}^v(?<version>.*)${{/if}}",
"depTypeTemplate": "libraries"
}
]
}
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,16 @@ $ ./build.sh --without-w64 --without-linux --with-macos

## Dependency upgrades

Libraries are downloaded from hard-coded URL in `lib/build.sh`. Libraries can be upgraded by changing the version number in `lib/variable.sh`.
Libraries are downloaded from hard-coded URL defined in the [lib/CMakeLists.txt](lib/CMakeLists.txt) CMake project.

These libraries can be upgraded by changing the version number in the [lib/VERSIONS](lib/VERSIONS) file.

This repository uses [Renovate](https://github.com/renovatebot/renovate) as an automated dependency upgrade checking mechanism:

* The [Renovate Github app](https://github.com/apps/renovate) will periodically check the dependencies for updates
* The [lib/VERSIONS](lib/VERSIONS) file also contains Bash comments parsed by Renovate. These comments are used by Renovate to find out which data source to use to check for the latest versions of dependencies (see [Regex Managers](https://docs.renovatebot.com/configuration-options/#regexmanagers) feature)

The Renovate configuration is located in [.github/renovate.json](.github/renovate.json).

## Benchmark

Expand Down

0 comments on commit 69bf715

Please sign in to comment.