Skip to content

Commit

Permalink
[chore] track markdown-link-check with renovate (open-telemetry#36552)
Browse files Browse the repository at this point in the history
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description
This PR adds markdown-link-check to the tracked dependencies of
renovate. It achieves that by using the
[`customManagers:githubActionsVersions`](https://docs.renovatebot.com/presets-customManagers/#custommanagersgithubactionsversions)
renovate preset that enables user to update arbitrary versions in github
actions files without having to maintain their own regex for them.

<!-- Issue number (e.g. open-telemetry#1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes open-telemetry#36259

<!--Describe what testing was performed and which tests were added.-->
#### Testing
This setup is already in use in the dynatrace collector distro and works
great: [latest update
PR](Dynatrace/dynatrace-otel-collector#382),
[renovate
config](https://github.com/Dynatrace/dynatrace-otel-collector/blob/07e4662f92b0cadfb311eca74c9269c1c1598634/renovate.json#L6)

---------

Signed-off-by: Moritz Wiesinger <[email protected]>
  • Loading branch information
mowies authored and sbylica-splunk committed Dec 17, 2024
1 parent c37f684 commit 9dc30d3
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 3 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/changelog.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ env:
# Make sure to exit early if cache segment download times out after 2 minutes.
# We limit cache download as a whole to 5 minutes.
SEGMENT_DOWNLOAD_TIMEOUT_MINS: 2
# renovate: datasource=github-releases depName=tcort/markdown-link-check
MD_LINK_CHECK_VERSION: "3.12.2"

concurrency:
group: ${{ github.workflow }}-${{ github.head_ref }}
Expand Down Expand Up @@ -84,7 +86,7 @@ jobs:
run: make chlog-preview > changelog_preview.md
- name: Install markdown-link-check
if: ${{ !contains(github.event.pull_request.labels.*.name, 'dependencies') && !contains(github.event.pull_request.labels.*.name, 'Skip Changelog') && !contains(github.event.pull_request.title, '[chore]')}}
run: npm install -g markdown-link-check@3.12.2
run: npm install -g markdown-link-check@${{ env.MD_LINK_CHECK_VERSION }}
- name: Run markdown-link-check
if: ${{ !contains(github.event.pull_request.labels.*.name, 'dependencies') && !contains(github.event.pull_request.labels.*.name, 'Skip Changelog') && !contains(github.event.pull_request.title, '[chore]')}}
run: |
Expand Down
6 changes: 5 additions & 1 deletion .github/workflows/check-links.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
cancel-in-progress: true

env:
# renovate: datasource=github-releases depName=tcort/markdown-link-check
MD_LINK_CHECK_VERSION: "3.12.2"

jobs:
changedfiles:
name: changed files
Expand Down Expand Up @@ -36,7 +40,7 @@ jobs:
fetch-depth: 0

- name: Install markdown-link-check
run: npm install -g markdown-link-check@3.12.2
run: npm install -g markdown-link-check@${{ env.MD_LINK_CHECK_VERSION }}

- name: Run markdown-link-check
run: |
Expand Down
5 changes: 4 additions & 1 deletion renovate.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@
"go": "1.22.0"
},
"schedule": ["every tuesday"],
"extends": ["config:recommended"],
"extends": [
"config:recommended",
"customManagers:githubActionsVersions"
],
"ignorePaths": [
"**/receiver/apachesparkreceiver/testdata/integration/Dockerfile.apache-spark",
"**/receiver/elasticsearchreceiver/testdata/integration/Dockerfile.elasticsearch.7_16_3",
Expand Down

0 comments on commit 9dc30d3

Please sign in to comment.