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

Fix nimbus fetching mechanism for ReadTheDocs #2001

Merged
merged 4 commits into from
Nov 20, 2024
Merged

Fix nimbus fetching mechanism for ReadTheDocs #2001

merged 4 commits into from
Nov 20, 2024

Conversation

Zeitsperre
Copy link
Collaborator

@Zeitsperre Zeitsperre commented Nov 20, 2024

Pull Request Checklist:

  • This PR addresses an already opened issue (for bug fixes / features)
    • This PR fixes #xyz
  • Tests for the changes have been added (for bug fixes / features)
    • (If applicable) Documentation has been added / updated (for bug fixes / features)
  • CHANGELOG.rst has been updated (with summary of main changes)
    • Link to issue (:issue:number) and pull request (:pull:number) has been added

What kind of change does this PR introduce?

  • Overloads the fetch() method of nimbus() to add a UserAgent, thus preventing requests from ReadTheDocs from being forbidden by GitHub.
  • Fixes up the logic for fetching the registry.txt files and testing data from non-Ouranosinc/xclim-testdata repositories that follow the same conventions (forks, xhydro-testdata, etc.).

Does this PR introduce a breaking change?

Not really. The fetch calls have been modified and the registry files for non-Ouranosinc/xclim-testdata files are now saved to the testing folder with the following convention: registry.{repo-name}.{branch-name}.txt.

Other information:

readthedocs/readthedocs.org#11763

@Zeitsperre Zeitsperre added bug Something isn't working standards / conventions Suggestions on ways forward labels Nov 20, 2024
@Zeitsperre Zeitsperre self-assigned this Nov 20, 2024
Copy link
Contributor

@RondeauG RondeauG left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@github-actions github-actions bot added the approved Approved for additional tests label Nov 20, 2024
@Zeitsperre Zeitsperre merged commit 13c4842 into main Nov 20, 2024
21 checks passed
@Zeitsperre Zeitsperre deleted the fix-fetch branch November 20, 2024 21:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Approved for additional tests bug Something isn't working standards / conventions Suggestions on ways forward
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants