-
Notifications
You must be signed in to change notification settings - Fork 0
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
docs site and gh workflows #15
Conversation
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.
PR Type: Enhancement
PR Summary: The pull request introduces a new continuous integration workflow, updates existing pre-release and release workflows, and sets up the initial documentation site for the project. It includes the addition of a GitHub Actions workflow for CI, which runs tests across multiple Python versions and operating systems. The documentation site setup involves configuring Quarto and adding a sidebar for navigation.
Decision: Comment
📝 Type: 'Enhancement' - not supported yet.
- Sourcery currently only approves 'Typo fix' PRs.
✅ Issue addressed: this change correctly addresses the issue or implements the desired feature.
No details provided.
📝 Complexity: the changes are too large or complex for Sourcery to approve.
- Unsupported files: the diff contains files that Sourcery does not currently support during reviews.
General suggestions:
- Ensure that the favicon and logo assets are included if available, as they contribute to the professional appearance of the documentation site.
- Review the parallel testing configuration to ensure that tests are properly isolated and can run concurrently without issues.
- Consider the consistency of the Poetry commands across different workflows to maintain clarity and avoid confusion.
Thanks for using Sourcery. We offer it for free for open source projects and would be very grateful if you could help us grow. If you like it, would you consider sharing Sourcery on your favourite social media? ✨
matrix: | ||
python: ["3.8", "3.9", "3.10", "3.11", "3.12"] | ||
os: ["ubuntu-latest"] | ||
pytest_opts: ["--workers 4 --tests-per-worker 1"] |
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.
suggestion (llm): The use of parallel testing with pytest can significantly improve test suite execution time. However, ensure that tests are isolated and do not have shared state that could lead to flaky tests when run in parallel.
initial setup of docs site.