-
Notifications
You must be signed in to change notification settings - Fork 68
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
[SYNPY-1274] pre commit in gh action #1001
Conversation
@@ -1,4 +1,3 @@ | |||
sphinx | |||
sphinx-argparse | |||
sphinx_rtd_theme | |||
-e . |
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.
Having this included was giving me:
ERROR: file:///home/bfauble/BryansGreatWorkspace/synapsePythonClient/docs (from -r requirements.txt (line 4)) does not appear to be a Python project: neither 'setup.py' nor 'pyproject.toml' found.
Also - the pre-commit wanted to move this to line 1 - which is what prompted me to look at this.
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 think this was included only for a test read the docs integration.
Let's revisit the doc deployment strategy later on. It's an inconvenience that we have to build it ourselves when deploying - and our build doesn't allow for deployment of docs of past versions on our site.
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.
🔥 Going to pre-approve.
@@ -1,4 +1,3 @@ | |||
sphinx | |||
sphinx-argparse | |||
sphinx_rtd_theme | |||
-e . |
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 think this was included only for a test read the docs integration.
Let's revisit the doc deployment strategy later on. It's an inconvenience that we have to build it ourselves when deploying - and our build doesn't allow for deployment of docs of past versions on our site.
* run pre-commit before test stage
Problem:
We were only running the black linter during the GH action - which does not enforce everything the
pre-commit
check did.Solution:
I set up
pre-commit
job that runs this action: https://github.com/pre-commit/actionTesting: