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

Ensure tcort/markdown-link-check is pinned until recent versions are fixed #36588

Closed
ChrsMark opened this issue Nov 28, 2024 · 0 comments · Fixed by #36645
Closed

Ensure tcort/markdown-link-check is pinned until recent versions are fixed #36588

ChrsMark opened this issue Nov 28, 2024 · 0 comments · Fixed by #36645
Labels
needs triage New item requiring triage

Comments

@ChrsMark
Copy link
Member

Component(s)

No response

Describe the issue you're reporting

At #36586 we had to revert the upgrade happened by #36555.

We need to ensure that renovate bot won't upgrade this dependency again without running the relevant tests.

Original PRs that pinned the markdown-link-check version: #36231 #36223

/cc @mx-psi @mowies @niwoerner

@ChrsMark ChrsMark added the needs triage New item requiring triage label Nov 28, 2024
andrzej-stencel pushed a commit that referenced this issue Dec 11, 2024
#### Description
This PR will run the "markdown-link-check" tool if the version of the
tool 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 version gets updated, it will
only check the updated files to keep the same behaviour as before.~~

~~If only the version gets updated it will test all existing *.md
files.~~

**EDIT:** 

After feedback and suggestion from @mowies (thank you again! :) ), I
switched to use a
[predefined](https://github.com/tj-actions/changed-files) github action
which checks markdown files changes AND if the
`.github/workflows/check-links.yaml` changed.

If the '.github/workflows/check-links.yaml' file, the
markdown-link-check tool will test against all markdown files existing
in the repo. This would catch a version change of the
"markdown-link-check" tool and test it accordingly.

If 1+ *.md file gets changed while the
`.github/workflows/check-links.yaml` file does **not** change, it will
only test the changed files to keep the same behaviour like before.

/cc @mx-psi @mowies @ChrsMark 

#### Link to tracking issue
Fixes
#36588

---------

Co-authored-by: Christos Markou <[email protected]>
sbylica-splunk pushed a commit to sbylica-splunk/opentelemetry-collector-contrib that referenced this issue Dec 17, 2024
#### Description
This PR will run the "markdown-link-check" tool if the version of the
tool 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 version gets updated, it will
only check the updated files to keep the same behaviour as before.~~

~~If only the version gets updated it will test all existing *.md
files.~~

**EDIT:** 

After feedback and suggestion from @mowies (thank you again! :) ), I
switched to use a
[predefined](https://github.com/tj-actions/changed-files) github action
which checks markdown files changes AND if the
`.github/workflows/check-links.yaml` changed.

If the '.github/workflows/check-links.yaml' file, the
markdown-link-check tool will test against all markdown files existing
in the repo. This would catch a version change of the
"markdown-link-check" tool and test it accordingly.

If 1+ *.md file gets changed while the
`.github/workflows/check-links.yaml` file does **not** change, it will
only test the changed files to keep the same behaviour like before.

/cc @mx-psi @mowies @ChrsMark 

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

---------

Co-authored-by: Christos Markou <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs triage New item requiring triage
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant