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

[develop]: Update requests and certifi in requirements.txt #1103

Merged
merged 2 commits into from
Jul 15, 2024

Conversation

gspetro-NOAA
Copy link
Collaborator

DESCRIPTION OF CHANGES:

The Dependabot PR #1101 identified the need to update the certifi version, but requests should also be updated from the current (yanked) version in the requirements file.

Type of change

  • This change requires a documentation update

TESTS CONDUCTED:

None required. Generated the requirements file locally with the proposed upgrade to certifi and then resolved warnings generated by the requests version. With these two updates, the requirements.txt file can be generated without warnings or errors.

DEPENDENCIES:

None.

DOCUMENTATION:

All documentation.

ISSUE:

Fixes issue identified in Dependabot PR #1101

CHECKLIST

  • My code follows the style guidelines in the Contributor's Guide
  • I have performed a self-review of my own code using the Code Reviewer's Guide
  • I have commented my code, particularly in hard-to-understand areas (N/A)
  • My changes need updates to the documentation. I have made corresponding changes to the documentation
  • My changes do not require updates to the documentation (explain). (N/A)
  • My changes generate no new warnings
  • New and existing tests pass with my changes (N/A)
  • Any dependent changes have been merged and published (N/A)

Copy link
Collaborator

@MichaelLueken MichaelLueken left a comment

Choose a reason for hiding this comment

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

Thanks for going through and updating the versions of both certifi and requests, @gspetro-NOAA! Since you updated the "yanked" version of requests as well, I think I would prefer to get this PR in, then close PR #1101.

@natalie-perlin
Copy link
Collaborator

Could the ./ufs-srweather-app/doc/README be updates as well in this PR?

When sphinx, sphinx-rtd-theme have been installed (not going into the details of installations), the way to build the html documentaion requires the following:

$ cd ufs-srweather-app/doc
$ cp conf.py UsersGuide/.
$ make clean && sphinx-build -b html UsersGuide/ build

The above three lines would replace lines 23-24 in the current README
https://github.com/ufs-community/ufs-srweather-app/blob/develop/doc/README

@gspetro-NOAA
Copy link
Collaborator Author

@natalie-perlin I updated the doc README (and the regular README), but I used a two-line update rather than what you suggested. There should be no need to copy the conf.py file anywhere.

@MichaelLueken
Copy link
Collaborator

Thank you for updating the README files as well, @gspetro-NOAA! Moving forward with merging this work now.

@MichaelLueken MichaelLueken merged commit 29429fe into ufs-community:develop Jul 15, 2024
2 checks passed
natalie-perlin pushed a commit to natalie-perlin/ufs-srweather-app that referenced this pull request Aug 15, 2024
…nity#1103)

* The Dependabot PR ufs-community#1101 identified the need to update the certifi version, but requests should also be updated from the current (yanked) version in the requirements file.
* The README.md and doc/README files have also been updated.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants