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

Link checker report #1769

Closed
github-actions bot opened this issue May 4, 2022 · 7 comments
Closed

Link checker report #1769

github-actions bot opened this issue May 4, 2022 · 7 comments
Assignees
Labels
automated issue report Type: Documentation Improvements or additions to documentation

Comments

@github-actions
Copy link
Contributor

github-actions bot commented May 4, 2022

Summary

Status Count
πŸ” Total 484
βœ… Successful 302
⏳ Timeouts 0
πŸ”€ Redirected 0
πŸ‘» Excluded 175
❓ Unknown 0
🚫 Errors 7

Errors per input

Errors in doc/src/explore/devnet.md

Errors in doc/src/build/wallet.md

Errors in doc/src/build/json-rpc.md

Errors in doc/src/build/fullnode.md

Errors in explorer/client/README.md

Errors in sdk/typescript/README.md

Full Github Actions output

@Clay-Mysten
Copy link
Contributor

Thanks, Francois. All of the files in doc/src/ should be fixed as of this morning. Will work on the rest in time.

Looking back for instructions on adding myself as the default assignee for these in Slack, which is a terrible archive BTW. Can you add those instructions here or make the change yourself and send me the PR? Let's automate this! Thanks.

@huitseeker
Copy link
Contributor

@Clay-Mysten link to the last run, which did update things here: https://github.com/MystenLabs/sui/runs/6567281484?check_suite_focus=true

@Clay-Mysten
Copy link
Contributor

But this precise report (issue #1769) is 22 days old. I thought an issue would be generated each week as here. And my change made me one of the auto-assignees.

Will I get a report of broken links or not? Must I check a link above manually to see any broken links? How? Where do I find the link in the first place?

@Clay-Mysten
Copy link
Contributor

Adding @longbowlu for thoughts on how to best get our checks running continuously.

@huitseeker
Copy link
Contributor

huitseeker commented May 26, 2022

@Clay-Mysten

this precise report (issue #1769) is 22 days old.
While this issue is 22 days old, its contents were refreshed 2 days ago.

I thought an issue would be generated each week as here.

That's not how it works: if the pre-existing Link report is not closed, the CI updated the report rather than create a new issue. This creates less churn / confusion. Here's the code that does that:

- name: Find the last report issue open
uses: micalevisk/last-issue-action@v1.2
id: last_issue
with:
state: open
labels: |
report
automated issue
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Create issue from report file
if: ${{ steps.last_issue.outputs.has_found == 'false' }}
uses: peter-evans/create-issue-from-file@v4
with:
title: Link checker report
content-filepath: ${{ env.LYCHEE_OUT }}
assignees: Clay-Mysten, awelc, lxfind, patrickkuo
issue-number: ${{ steps.last_issue.outputs.issue_number }}
labels: |
report
automated issue
- name: Update last report open issue created
if: ${{ steps.last_issue.outputs.has_found == 'true' }}
uses: peter-evans/create-issue-from-file@v4
with:
title: Link checker report
content-filepath: ${{ env.LYCHEE_OUT }}
issue-number: ${{ steps.last_issue.outputs.issue_number }}
labels: |
report
automated issue

And my change made me one of the auto-assignees.

yep.

Will I get a report of broken links or not? Must I check a link above manually to see any broken links? How? Where do I find the link in the first place?

If a link report is open, the engine found broken links (the issue will be closed when there are no more broken links).

To find this report, you can use the tags that the CI employs in updating or creating the broken link report, namely "report" and "automated issue":
https://github.com/MystenLabs/sui/issues?q=is%3Aopen+is%3Aissue+label%3Areport+label%3A%22automated+issue%22

@huitseeker
Copy link
Contributor

@Clay-Mysten I've added a basic ignore file for the checker here: #2252
You can augment that file, so that the checker ignores the irrelevant URLs in the link report above. With suitable edits (making the checker ignore 127.0.0.1, gateway.devnet.sui.io) , that would lead to an empty report and close the present issue.

@Clay-Mysten
Copy link
Contributor

Let's start fresh. Closing this out!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automated issue report Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants