Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use Renovate for markdown-link-check updates #11606

Closed
andrzej-stencel opened this issue Nov 5, 2024 · 2 comments · Fixed by #11725
Closed

Use Renovate for markdown-link-check updates #11606

andrzej-stencel opened this issue Nov 5, 2024 · 2 comments · Fixed by #11725
Labels
ci-cd CI, CD, testing, build issues enhancement New feature or request release:retro Issues discussed in a release retrospective

Comments

@andrzej-stencel
Copy link
Member

The version of markdown-link-check took has been pinned to a specific version in #11605 due to a bug in the most recent release tcort/markdown-link-check#368.

Ideally the version of the tool should be updated automatically by Renovate bot by creating a pull request on every new release of the tool. This would allow us to control the version used and only ever use a version that actually works.

@andrzej-stencel andrzej-stencel added enhancement New feature or request ci-cd CI, CD, testing, build issues labels Nov 5, 2024
@mx-psi mx-psi added the release:retro Issues discussed in a release retrospective label Nov 5, 2024
@andrzej-stencel
Copy link
Member Author

Looks like nothing needs to be changed, Renovate is already doing its job: #11608.

@andrzej-stencel
Copy link
Member Author

andrzej-stencel commented Nov 5, 2024

Not exactly true. It's true that Renovate correctly creates a PR to update markdown-link-check, but the problem is, the check-links job is not run for this PR (see

if: ${{needs.changedfiles.outputs.md}}
). As a result, there is no way to know if the update does not break the tool.

We need to change the check-links job to also be run when the tool is updated - e.g. when package.json file is changed.

HongChenTW pushed a commit to HongChenTW/opentelemetry-collector that referenced this issue Dec 19, 2024
…ry#11725)

#### Description
This PR will run the "markdown-link-check" tool if the package.json
changes even if no markdown files were updated. This will help to
confirm that "markdown-link-check" is still working as expected after a
version update/pin.

If 1+ *.md files gets changed AND the package.json gets updated, it will
only check the updated files to keep the same behaviour as before.

If only the package.json gets updated it will test all existing *.md
files.

#### Link to tracking issue
Fixes
open-telemetry#11606

#### Testing

I tested/reproduced this manually: 

1. *.md file changes, but package.json not:
https://github.com/niwoerner/opentelemetry-collector/actions/runs/11959750938
2. *.md file and package.json changes:
https://github.com/niwoerner/opentelemetry-collector/actions/runs/11959777300
3. *.md file doesn't change but package.json:
https://github.com/niwoerner/opentelemetry-collector/actions/runs/11959797335
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci-cd CI, CD, testing, build issues enhancement New feature or request release:retro Issues discussed in a release retrospective
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants