Skip to content

Update docs theme to 1.0.6 and add CI#886

Merged
zimnx merged 3 commits intoscylladb:masterfrom
tnozicka:fix-python-deps
Jan 5, 2022
Merged

Update docs theme to 1.0.6 and add CI#886
zimnx merged 3 commits intoscylladb:masterfrom
tnozicka:fix-python-deps

Conversation

@tnozicka
Copy link
Copy Markdown
Contributor

@tnozicka tnozicka commented Dec 13, 2021

Description of your changes:
We need to bump vulnerable dependencies. Also the same sources must produce the same results and not randomly pick a new version that can break it.

This also bumps our docs theme to 1.0.6.

@tnozicka tnozicka added kind/bug Categorizes issue or PR as related to a bug. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. labels Dec 13, 2021
@tnozicka tnozicka added this to the v1.7 milestone Dec 13, 2021
@tnozicka tnozicka requested a review from zimnx December 13, 2021 12:59
@tnozicka tnozicka marked this pull request as draft December 13, 2021 12:59
@tnozicka
Copy link
Copy Markdown
Contributor Author

hm, we need CI for this

@tnozicka tnozicka force-pushed the fix-python-deps branch 2 times, most recently from 475de5f to a37686c Compare December 15, 2021 13:21
@tnozicka tnozicka changed the title Update and pin python dependencies for docs Update docs theme to 1.0.6 and add CI Dec 15, 2021
@tnozicka
Copy link
Copy Markdown
Contributor Author

tnozicka commented Dec 15, 2021

I picked up logical changes from #815 to fix the CI errors and bump our docs theme

@tnozicka tnozicka added kind/documentation Categorizes issue or PR as related to documentation. and removed kind/bug Categorizes issue or PR as related to a bug. labels Dec 15, 2021
@tnozicka tnozicka force-pushed the fix-python-deps branch 9 times, most recently from 2cb834e to 4066e3c Compare December 16, 2021 08:20
@tnozicka tnozicka marked this pull request as ready for review December 16, 2021 08:21
Comment thread .github/workflows/docs.yaml Outdated
Comment thread docs/source/conf.py Outdated
@tnozicka tnozicka force-pushed the fix-python-deps branch 2 times, most recently from 5bae84b to a163338 Compare December 27, 2021 13:46
Comment thread .github/workflows/docs.yaml Outdated
Comment thread .github/workflows/docs.yaml Outdated
Comment thread docs/Makefile
.PHONY: multiversion

.PHONY: multiversionpreview
multiversionpreview: multiversion
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

why is this dependency removed? It doesn't make sense to start server without building sources

Copy link
Copy Markdown
Contributor Author

@tnozicka tnozicka Jan 4, 2022

Choose a reason for hiding this comment

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

you could have built the sources already. if you make it a hard dependency it forces everyone to rebuild before every run, even if nothing changed and it was already built

@tnozicka tnozicka marked this pull request as draft January 4, 2022 10:17
@tnozicka tnozicka force-pushed the fix-python-deps branch 9 times, most recently from de958d2 to b15f4cc Compare January 5, 2022 11:51
@tnozicka tnozicka marked this pull request as ready for review January 5, 2022 11:51
Comment thread .github/actions/docs/build/action.yaml Outdated
Comment on lines +1 to +2
name: "Setup Documentation Essentials and Build"
description: 'Sets up dependencies and builds the docs'
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
name: "Setup Documentation Essentials and Build"
description: 'Sets up dependencies and builds the docs'
name: "Build documentation and upload artifacts"
description: 'Builds the docs and uploads artifacts'

Comment thread .github/workflows/docs_build.yaml Outdated
- 'v[0-9]+.[0-9]+'
paths:
- 'docs/**'
- '.github/workflows/docs_build.yaml'
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

changes in .github/actions/* won't trigger the build, and should. Maybe entire .github/** should be here and below

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

yeah, I've changed the path since. I've made it test always, and restricted deploys to .github/**

Comment thread .github/workflows/docs_deploy.yaml Outdated
# checks out random tips of other branches and the code isn't build just from
# what triggered the event. For any branch that changes we need to always
# build and deploy from master :(
# Triggering a job from multiple branches in parallel is racy, but it's wht we have :(
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
# Triggering a job from multiple branches in parallel is racy, but it's wht we have :(
# Triggering a job from multiple branches in parallel is racy, but it's what we have :(

@tnozicka tnozicka force-pushed the fix-python-deps branch 2 times, most recently from ff68c03 to 2f12cc8 Compare January 5, 2022 14:20
Copy link
Copy Markdown
Contributor

@zimnx zimnx left a comment

Choose a reason for hiding this comment

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

LGTM, thanks

@zimnx zimnx enabled auto-merge January 5, 2022 14:28
@zimnx zimnx merged commit cd8d30f into scylladb:master Jan 5, 2022
@tnozicka tnozicka deleted the fix-python-deps branch January 5, 2022 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/documentation Categorizes issue or PR as related to documentation. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants