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

Find a way to share pre-commit/prospector config with .org and .com #196

Open
stsewd opened this issue Feb 5, 2024 · 0 comments
Open

Find a way to share pre-commit/prospector config with .org and .com #196

stsewd opened this issue Feb 5, 2024 · 0 comments
Labels
Improvement Minor improvement to code

Comments

@stsewd
Copy link
Member

stsewd commented Feb 5, 2024

Currently our pre-commit settings for prospector doesn't really work well.

Can't be re-used in .com, we had to disable that check https://github.com/readthedocs/readthedocs-corporate/pull/1698. The reason it fails is because of two things:

  • The Python path: when running on CI, we clone the readthedocs.org repo in the .tox/py310/readthedocs.org directory, but in dev, we have this repo in the upper directory (../readthedocs.org).
  • Requirements: prospector creates a separate environment to run in, due to this, we need to install the requirements inside that environment, and since we are sharing this file for both of our repos, we ended up installing the requirements from a URL, this is a problem if a new dep is added in a PR, or if .com needs an additional dep that isn't on .org.
    - https://raw.githubusercontent.com/readthedocs/readthedocs.org/main/requirements/testing.txt
@humitos humitos added the Improvement Minor improvement to code label Feb 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code
Projects
None yet
Development

No branches or pull requests

2 participants