Skip to content

Add a command to automatically replace broken links and open PRs #4908

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.

Sign up for GitHub

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

Jump to bottom
Draft
wants to merge 81 commits into
base: az/search-n-replace-pr
Choose a base branch
from
Draft

Add a command to automatically replace broken links and open PRs #4908

wants to merge 81 commits into from

Conversation

necto
Copy link
Contributor

@necto necto commented Apr 7, 2025

@frederic-tingaud-sonarsource Here is a draft command, relying on #4907 and #4903. It is not merge-quality yet, as it depends on several other PRs that might change before this gets a chance to merge. It does work, however, so if you run it with a GITHUB_TOKEN in the environment, you can nudge multiple people to fix the broken links. If you agree this would be a useful command, I can refine this PR to make it reado for a review

necto added 30 commits April 6, 2025 11:18
@necto
refactor: use temporary files in link tests instead of static resources
2baa655
@necto
style: fix code formatting in test_links.py
0c7a2b4
@necto
Remove unecessary resource files for self-contained test_links.py
eda0db0
@necto
refactor: make link probes history file path configurable
9fbebd9
@necto
style: format code with consistent line breaks and indentation
e851e21
@necto
test: add history file to link checking tests
54e9be0
@necto
style: format code to comply with linting rules
d24b008
@necto
test: add test for not reprobing recently checked links
43e4a4c
@necto
style: format test_links.py with proper indentation
f8b40b0
@necto
test: add test for rechecking links after cooldown period
748ee99
@necto
style: improve code formatting by breaking long line into multiple lines
e1d27fb
@necto
test: add test for tolerable downtime period for recently alive links
60d0163
@necto
style: improve formatting in test_links.py
c39249d
@necto
refactor: mock live_url instead of url_is_long_dead in test_tolerable…
082c480 
…_downtime
@necto
test: add test for detecting dead links with expired tolerable downtime
0795226
@necto
test: verify exception URLs are not probed and reported as live
749fdfe
@necto
style: fix whitespace in test_links.py
b5ee689
@necto
fix: prevent division by zero in checklinks hit ratio calculation
05a50d8
@necto
refactor: improve test_no_reprobe_recent_links to use real probing se…
770b3d1 
…quence
@necto
style: remove trailing whitespace from test_links.py
3b546fa
@necto
refactor: rewrite test to run check-links twice instead of mocking hi…
5f7d167 
…story file
@necto
style: improve formatting in test_links.py
c42938f
@necto
refactor: extract helper function for history file setup in link tests
77c810a
@necto
style: fix indentation and spacing in test_links.py
5103fa5
@necto
refactor: use setup_history_file in link tests
97023ec
@necto
style: format long function calls in test_links.py
05f9f9c
@necto
refactor: simplify test_links.py setup_history_file function
b5596e8
@necto
refactor: simplify setup_history_file to always mock date parameter
435c17e
@necto
fix: reorder function parameters to fix non-default parameter after d…
f902ba1 
…efault
@necto
style: fix code formatting in test_links.py
df5b9c9
necto added 27 commits April 6, 2025 13:32
@necto
refactor: use setup_history_file helper in test_mixed_links_reporting
2114a22
@necto
refactor: extract CLI runner with mocked live_url into helper function
9816172
@necto
fix: correct indentation in test assertions for link testing methods
e48da81
@necto
style: fix whitespace issues in test_links.py
63602c0
@necto
test: add test for multiple links in a single HTML file
0b4d739
@necto
style: fix string quotes and line breaks in test_links.py
39ed161
@necto
test: add test for dead links reporting in multiple files
9e77f5d
@necto
style: format test_links.py by fixing indentation and line breaks
e78d388
@necto
refactor: extract error section computation into a utility function
9f5dbc0
@necto
style: format whitespace in test_links.py docstring
88f3c8e
@necto
test: add test for history file creation in check-links command
06b35d0
@necto
style: clean up whitespace in test_links.py
0ea0d5a
@necto
refactor: use helper function for file creation in test_create_histor…
11b1df8 
…y_file
@necto
style: fix trailing comma and whitespace in test_links.py
c1d447b
@necto
test: add tests for anchor-only links in live_url function
24cd8ed
@necto
style: remove trailing whitespace in test_links.py
458cb7c
@necto
Fix diff application
3a45ccb
@necto
test: add test for links initially dead but alive on confirmation
6ec578e
@necto
style: format test_links.py by removing trailing whitespace
b08c034
@necto
Merge branch 'az/linkcheck-testing' into az/search-n-replace-pr
3b20267
@necto
refactor: split probe_links into three focused functions
3b74400
@necto
style: remove trailing whitespace in checklinks.py
adef5ee
@necto
feat: add CLI command to replace broken links with web archive URLs
cb8d7e4
@necto
Revert "refactor triggered by stale ai! comment"
382bab7 
This reverts parts of commit cb8d7e4.
@necto
Remove stale AI! comment
ff8f166
@necto
More elaborate PR description
e34172e
@necto
A detail
c46aee0
@necto necto added the rspec system Related to handling of rspecs (scripts, doc...) label Apr 7, 2025
@sonarqube-next SonarQube-Next
Copy link

sonarqube-next bot commented Apr 7, 2025

Quality Gate failed Quality Gate failed for 'rspec-tools'

Failed conditions
3 New issues
58.0% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE SonarQube for IDE

@sonarqube-next SonarQube-Next
Copy link

sonarqube-next bot commented Apr 7, 2025

Quality Gate passed Quality Gate passed for 'rspec-frontend'

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
rspec system Related to handling of rspecs (scripts, doc...)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@necto