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

Automation/CI checks wanted #6233

Closed
7 tasks done
TicClick opened this issue Oct 15, 2021 · 3 comments
Closed
7 tasks done

Automation/CI checks wanted #6233

TicClick opened this issue Oct 15, 2021 · 3 comments
Labels
area:meta non-article files

Comments

@TicClick
Copy link
Contributor

TicClick commented Oct 15, 2021

@TicClick TicClick added the area:meta non-article files label Oct 15, 2021
@TicClick
Copy link
Contributor Author

#3310 could be a source of ideas for the remark plugins

@TicClick TicClick changed the title CI checks wanted Automation/CI checks wanted Oct 18, 2021
@sr229
Copy link
Contributor

sr229 commented Oct 24, 2021

Broken links is going to be tricky since you will want your analysis to have an idea of the entire repo tree structure and work your way from there. I did something like this in the Cartographer project to make an autogenerated sitemap but I assume remark has a way to read entire project trees and compare links against the tree.

Walavouchey added a commit to Walavouchey/osu-wiki that referenced this issue May 6, 2022
The wikilink checker is updated with changes
from Walavouchey/osu-wiki-tools@76f2b53
to Walavouchey/osu-wiki-tools@14ee28d
to make some more progress towards ppy#6233. The full commit history along
with tests can be viewed in that repo.

The two main features of reference- and in-article link checking require
additional parsing logic to handle ignoring comments and getting the
correct identifier from headings and custom identifier tags. For
in-article links, the articles they point to are parsed for their
identifiers in order to check if the #link-fragment is correct.

By default, all links from outdated articles are ignored. The plan is to
eventually turn on link checking for all files in CI runs when the
remaining errors have been fixed, so this is to prevent contributors
from having to edit already outdated articles.

Currently on master this this runs for about 40s with `--outdated` and
about 32s without on my Windows machine. There are 144 remaining errors
without counting outdated articles and 236 errors in total.
Walavouchey added a commit to Walavouchey/osu-wiki that referenced this issue May 6, 2022
The wikilink checker is updated with changes
from Walavouchey/osu-wiki-tools@76f2b53
to Walavouchey/osu-wiki-tools@cdbfa96
to make some more progress towards ppy#6233. The full commit history along
with tests can be viewed in that repo.

The two main features of reference- and in-article link checking require
additional parsing logic to handle ignoring comments and getting the
correct identifier from headings and custom identifier tags. For
in-article links, the articles they point to are parsed for their
identifiers in order to check if the #link-fragment is correct, and if
not, all possible identifiers are printed as suggestions.

By default, all links from outdated articles are ignored. The plan is to
eventually turn on link checking for all files in CI runs when the
remaining errors have been fixed, so this is to prevent contributors
from having to edit already outdated articles.

Currently on master this this runs for about 40s with `--outdated` and
about 32s without on my Windows machine. There are 152 remaining errors
without counting outdated articles and 253 errors in total.
Walavouchey added a commit to Walavouchey/osu-wiki that referenced this issue May 6, 2022
The wikilink checker is updated with changes
from Walavouchey/osu-wiki-tools@76f2b53
to Walavouchey/osu-wiki-tools@cdbfa96
to make some more progress towards ppy#6233. The full commit history along
with tests can be viewed in that repo.

The two main features of reference- and in-article link checking require
additional parsing logic to handle ignoring comments and getting the
correct identifier from headings and custom identifier tags. For
in-article links, the articles they point to are parsed for their
identifiers in order to check if the #link-fragment is correct, and if
not, all possible identifiers are printed as suggestions.

By default, all links from outdated articles are ignored. The plan is to
eventually turn on link checking for all files in CI runs when the
remaining errors have been fixed, so this is to prevent contributors
from having to edit already outdated articles.

Currently on master this this runs for about 40s with `--outdated` and
about 32s without on my Windows machine. There are 152 remaining errors
without counting outdated articles and 253 errors in total.

Co-authored-by: TicClick <[email protected]>
@cl8n
Copy link
Member

cl8n commented Jun 25, 2022

moved to #2275

@cl8n cl8n closed this as completed Jun 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:meta non-article files
Projects
None yet
Development

No branches or pull requests

3 participants