Open an Issue when linkcheck fails

[laysauchoa]

Describe the feature you would like to be added.

Problem
Recently, we have added linkcheck to run periodically, every week. However, someone has to go and look for the failed build and do the fixes. This could go unseen or unnoticed.

Proposed solution
Automatically open an Issue when the linkcheck fails. So we can better monitor it and fix it. We can also assign to some of the maintainers

I will be happy to work on that

[github-actions]

Hi and welcome! Thanks for posting your first issue in the PyVista project! Someone from @pyvista/developers will chime in before too long. If your question is support related, we may transfer it to the Discussions.

[tkoyama010]

It is a great idea to have auto Pull Requests issue. We always welcome your contribution.

[laysauchoa]

@tkoyama010 this would be more like an issue saying that it failed, not the pull request with the fix.

[tkoyama010]

I'm sorry. I misunderstood your suggestion (I was imagining something like dependabot.). In this case, I also think Issue would be better.

[tkoyama010]

First of all, we don't know the correct URL automatically 😅

[banesullivan]

@laysauchoa, I think this is a great idea. Would you be willing to take this on?

I believe there are GitHub Actions that can open an issue like this easily.

I would set up the CI on a cronjob which:

1. runs link check and captures output as text
2. if fails, opens the issue with error text as body of the issue

[adeak]

@laysauchoa, I think this is a great idea. Would you be willing to take this on?

I believe there are GitHub Actions that can open an issue like this easily.

I would set up the CI on a cronjob which:

1. runs link check and captures output as text
2. if fails, opens the issue with error text as body of the issue

@laysauchoa humbly didn't link to it, but we already have #3166 thanks to them :) this machinery could be upgraded to open the issue.

[banesullivan]

Ah, thanks for pointing that out @adeak, and thank you @laysauchoa for already implementing most of this!

[laysauchoa]

Opening the issue works fine but I tried to catch the output from previous steps to add to the body of the issue and does not work because the GitHub action that I use for the issue does not support such a long output. I am trying to find an alternative for that, but so far nothing worked.

[banesullivan]

Do you have a prototype of the code pushed somewhere? I'd be happy to help

[laysauchoa]

Hi @banesullivan I think it can be something like the PR I linked

[laysauchoa]

can this issue be eligible for the hacktoberfest? If yes, can we add the label for it? thanks!

[adeak]

can this issue be eligible for the hacktoberfest? If yes, can we add the label for it? thanks!

My understanding is that PRs are what are eligible, and approved, merged PRs are valid automatically. That being said, @tkoyama010 diligently labels our merged PRs for hacktoberfest :)

[tkoyama010]

I mistook this for a PR, it is an ISSUE.

[laysauchoa]

Alright, clear! Thanks for clarifying :)

[laysauchoa]

Can I assign this issue to me? I've an open pull request about it.

[adeak]

Can I assign this issue to me? I've an open pull request about it.

I don't think you can, but I've assigned you now.