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

ci: add mkdocs Python deps to dependabot security updates #12612

Merged
merged 2 commits into from
Feb 8, 2024

Conversation

agilgur5
Copy link
Member

@agilgur5 agilgur5 commented Feb 3, 2024

Follow-up to #12360 that added docs/requirements.txt (glad to have a proper dep file for that!)

Motivation

  • same as our other deps, for security updates only
    • in particular, a scenario I can see possible is if mkdocs has an XSS vuln or something that would impact the docs site

Modifications

  • Add docs/ pip section to dependabot.yml

style: reorder dep sections

  • put Go, then NPM, then docs, then GH Actions
    • i.e. the most important prod impacting deps, then build deps

Verification

n/a, this can only be tested after updating

Notes to Reviewers

I was thinking about some of the NPM docs deps too, but those don't make it into prod, so I don't think they necessarily need to have security updates, but that wouldn't necessarily be bad practice to safeguard devDeps too.

  • they also need a proper dep file as well, currently they're installed directly in the Makefile as well as in the Nix flakes.

mkdocs is technically also a devDep, but the code it produces goes into the prod docs site, per the "Motivation" section above. So if mkdocs itself has a vuln, not a big issue, but if its generated code has a vuln, potentially an issue. There's no real way to distinguish between those two scenarios though, unfortunately.

- put Go, then NPM, then GH Actions
  - i.e. the most important prod impacting deps, then build deps

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
@agilgur5 agilgur5 added type/dependencies PRs and issues specific to updating dependencies area/docs Incorrect, missing, or mistakes in docs labels Feb 3, 2024
- same as our other deps, for security updates only
  - in particular, a scenario I can see possible is if `mkdocs` has an XSS vuln or something that would impact the docs site

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
@agilgur5 agilgur5 added type/security Security related area/build Build or GithubAction/CI issues labels Feb 3, 2024
@isubasinghe
Copy link
Member

Opinion on some kind of CI check to ensure the dependencies in Nix and otherwise are the same?
Should be relatively easy to do I think.

Just print out the version and diff them. Can be as a part of a later PR.

Copy link
Member

@isubasinghe isubasinghe left a comment

Choose a reason for hiding this comment

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

Ah the diff was annoying to read, but it looks good otherwise.

@isubasinghe isubasinghe merged commit b13e61e into argoproj:main Feb 8, 2024
19 checks passed
@agilgur5 agilgur5 deleted the ci-mkdocs-dependabot branch February 8, 2024 05:10
@agilgur5
Copy link
Member Author

agilgur5 commented Feb 8, 2024

Ah the diff was annoying to read, but it looks good otherwise.

Oh yea, the re-ordering made the diff look real wacky since some of the config is the same for each ecosystem, so the diff only shows the deps moving. Sorry I forgot to mention that!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/build Build or GithubAction/CI issues area/docs Incorrect, missing, or mistakes in docs type/dependencies PRs and issues specific to updating dependencies type/security Security related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants