-
Notifications
You must be signed in to change notification settings - Fork 3k
site: use virtualenv and add make lint #14428
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
Conversation
| deploy: # Clean, build, and deploy the Iceberg docs site. | ||
| dev/deploy.sh $(remote_name) | ||
|
|
||
| .PHONY: lint |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please update README for these commands.
| set -e | ||
|
|
||
| export REMOTE="iceberg_docs" | ||
| export VENV_DIR=".venv" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we ever clean up this dir?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i dont think so. i could add it to the clean command, but i think its also fine to leave it alone
|
@kevinjqliu Thanks for the follow-up PR. Can you also help to add |
site/README.md
Outdated
| ``` | ||
|
|
||
| It will also scan all markdown files and fail the build on any style issues. To fix style issues, run the `lint` script with fix mode. | ||
| It will also scan all markdown files and fail the build on any style issues. To fix style issues, run the `lint-fix` make command. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we need to mention lint-fix here, since it will be immediately covered in the following section.
|
@kevinjqliu Sorry, although my approval is marked green by GitHub, I'm not a committer and that should not count as one. |
|
oops, good catch @manuzhang. let me ping someone else |
|
Late LGTM |
|
Thank you @huaxingao. |
Follow up to #13977
This PR adds
make lintandmake lint-fixtosite/'s Makefile.This PR also creates a python virtual env to install the required libraries and runs docs-ci with ubuntu and macos
Tested