Skip to content

Fix qpx example URL in CI and documentation - #709

Merged
ypriverol merged 3 commits into
mainfrom
dev
Aug 13, 2026
Merged

Fix qpx example URL in CI and documentation#709
ypriverol merged 3 commits into
mainfrom
dev

Conversation

@ypriverol

@ypriverol ypriverol commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

Pull Request

Description

Brief description of the changes made in this PR.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Performance improvement
  • Code refactoring
  • Test addition/update
  • Updates to the dependencies has been done.

Summary by CodeRabbit

  • Bug Fixes

    • Improved example dataset downloads by starting HTTPS fallback immediately for non-FTP hosts.
    • Updated automated example-data retrieval to use a more reliable hosted archive.
  • Documentation

    • Updated QPX example download links across the documentation and example configuration.

The PRIDE copy of qpx_example.zip returns 404, so the test_qpx job fails at
the download step. This is specific to that one file, not a PRIDE outage --
the other assets this workflow pulls from the same host still serve fine
(LFQ_PXD007683.zip returns 200, 408 MB), so the remaining 24 PRIDE URLs are
left alone.

Points at the GitHub attachment copy instead. Verified it is the same file:
identical size (831,756 bytes) and identical sha256
(02c2a9bd314d81ebc50d0b24c98fe9aec526c8ce8d032fc9f38fe3251f435154), same 16
entries including results/multiqc_config.yml which the job passes to --config.

Ran the job's three steps locally against main with a clean Python 3.12
install: download, unzip, and the multiqc invocation. Exit 0, no tracebacks,
no swallowed failures, 24 sections, no duplicate anchors, 2.6 MB report.

Adds -O so the output name does not depend on the URL's trailing path.
Same 404 as the CI job: docs/config.json drives the example-report generation
and both qpx entries (qpx and qpx_disable_hoverinfo) pointed at the PRIDE copy
of qpx_example.zip, which no longer exists. The README download link pointed
there too. All three now use the GitHub attachment, verified identical by
sha256 (02c2a9bd...f435154, 831,756 bytes).

Only the qpx URLs change. The other 44 PRIDE URLs in config.json are fine --
PRIDE itself is up, it is this one file that is missing.

Also makes the FTP attempt conditional in update_examples.py. download_file
rewrites https:// to ftp:// and tries FTP three times with backoff before
falling back to HTTPS; against a host that never served FTP that is three
connection timeouts plus ~6s of sleep, twice, for no possible gain. It now
tries FTP only for hosts named ftp.*, so PRIDE keeps its retries and
HTTPS-only hosts go straight to the path that works.

Verified with the real downloader against the updated config: HTTPS on the
first attempt, 831,756 bytes, 0.7s.
ci: fetch the qpx example from a working URL
@qodo-code-review

Copy link
Copy Markdown
Contributor

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@coderabbitai

coderabbitai Bot commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 1b208d14-1134-47e6-ae32-8948601299d8

📥 Commits

Reviewing files that changed from the base of the PR and between 37d1408 and e13caa8.

📒 Files selected for processing (4)
  • .github/workflows/python-app.yml
  • docs/README.md
  • docs/config.json
  • docs/update_examples.py

📝 Walkthrough

Walkthrough

The QPX example archive now uses a GitHub-hosted URL in CI and documentation. Example updates skip FTP retries for non-FTP hosts and use HTTPS fallback directly.

Changes

QPX dataset source handling

Layer / File(s) Summary
Host-specific download fallback
docs/update_examples.py
FTP retries run only when the parsed host starts with ftp.. Other hosts proceed directly to HTTPS.
QPX archive source references
.github/workflows/python-app.yml, docs/README.md, docs/config.json
The QPX archive URL now points to a GitHub-hosted attachment in the workflow and documentation. Both QPX configurations use the updated URL.

Estimated code review effort: 2 (Simple) | ~10 minutes

Mergeability Score: ⚪ Minimal · up to e13ca

This PR updates the qpx example URL in CI and documentation. No actionable merge-blocking risk remains, so it is merge-ready after normal checks and review.

Possibly related PRs

Suggested reviewers: yueqixuan, daichengxin

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main change to the QPX example URL in CI and documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch dev

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

🟢 Metrics 0 complexity

Metric Results
Complexity 0

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@ypriverol
ypriverol requested a review from yueqixuan August 13, 2026 13:03
@ypriverol
ypriverol merged commit bc2d72b into main Aug 13, 2026
28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants