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

Pinning dependencies per OSSF security practices and coverting to ASCII #1582

Merged
merged 2 commits into from
Jul 2, 2024

Conversation

timmiesmith
Copy link
Contributor

https://github.com/ossf/scorecard/blob/main/docs/checks.md#pinned-dependencies recommends explicitly pinning dependencies to reduce several security risks.

Line endings in the file were inconsistent so I converted them all to ASCII instead of a mix of CR and CRLF line endings.

Copy link
Contributor

@danhoeflinger danhoeflinger left a comment

Choose a reason for hiding this comment

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

LGTM,
I checked that these version numbers are the current versions of these libraries.

danhoeflinger
danhoeflinger previously approved these changes May 13, 2024
Copy link
Contributor

@mmichel11 mmichel11 left a comment

Choose a reason for hiding this comment

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

LGTM

Edit: See below

Copy link
Contributor

@mmichel11 mmichel11 left a comment

Choose a reason for hiding this comment

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

These dependencies actually seem impossible to fulfill based on the CI failure:

    The user requested sphinx==4.4.0
    breathe 4.9.1 depends on Sphinx>=1.4
    sphinx-book-theme 1.1.2 depends on sphinx>=5

Would increasing the required sphinx version resolve this?

@danhoeflinger
Copy link
Contributor

These dependencies actually seem impossible to fulfill based on the CI failure:

    The user requested sphinx==4.4.0
    breathe 4.9.1 depends on Sphinx>=1.4
    sphinx-book-theme 1.1.2 depends on sphinx>=5

Would increasing the required sphinx version resolve this?

That may have unintended consequences. May be best to figure out which version of these was currently being used prior to this PR and just use those version numbers.

sphinxcontrib_qthelp<1.0.6
sphinxcontrib-serializinghtml<1.1.10

sphinx_book_theme==1.1.2
Copy link
Contributor

@danhoeflinger danhoeflinger May 13, 2024

Choose a reason for hiding this comment

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

Looking at another PR, it looks like this is correct (after rolling back to versions which work):
sphinx_book_theme==1.0.1
sphinx-tabs==3.4.5
sphinx-prompt==1.5.0
sphinx_substitution_extensions==2022.2.16

Copy link
Contributor Author

@timmiesmith timmiesmith May 14, 2024

Choose a reason for hiding this comment

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

Thanks. The version numbers I selected had been pulled from a previous PR, but I'm not able to find that PR now. Looking at the PR from depandabot earlier today I do see that it used the same version numbers you've listed above.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think it initially tries the numbers you originally had, but then backs them off later in the script due to dependencies.

@danhoeflinger danhoeflinger self-requested a review May 13, 2024 19:34
Copy link
Contributor

@danhoeflinger danhoeflinger left a comment

Choose a reason for hiding this comment

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

LGTM

@timmiesmith timmiesmith merged commit 497ca45 into main Jul 2, 2024
20 checks passed
@timmiesmith timmiesmith deleted the timmiesm/pin_dependencies branch July 2, 2024 14:35
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