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

CI/move link checking to pr checks #83

Merged
merged 2 commits into from
Aug 14, 2024

Conversation

f-hollow
Copy link
Collaborator

@f-hollow f-hollow commented Aug 8, 2024

This PR moves link checking from the merge checks to PR checks. If the contributed changes have invalid links, the workflow being contributed will block the PR merge. The PR will be unblocked only after all the invalid links are fixed or added to .lycheeignore for a good reason.

In addition to this PR, we need to create a ruleset for our main branch.

This PR also adds some links to the .lycheeignore file. These links require CAPTCHA checks, which is being reported by lychee as if the links are invalid. This is a known problem and ignoring such links is a standard solution.

After this PR, we can also add workflows for

  • Preventing PNG and JPEG images from being merged in favor of .webp
  • Checks for formatting
  • Linters and spellcheckers

Copy link
Member

@pedrominatel pedrominatel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@f-hollow f-hollow merged commit 879b780 into espressif:main Aug 14, 2024
1 check passed
@f-hollow f-hollow deleted the ci/move_link_checking_to_pr_checks branch August 14, 2024 12:12
f-hollow added a commit that referenced this pull request Aug 14, 2024
* ci: move link checking to checks blocking pr merge

* ci: include previously excluded nuttx-getting-started article from link checking
pedrominatel pushed a commit to pedrominatel/developer-portal that referenced this pull request Sep 12, 2024
* ci: move link checking to checks blocking pr merge

* ci: include previously excluded nuttx-getting-started article from link checking
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants