chore: project maintenance #186
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR performs general project maintenance by updating CI configuration and removing outdated documentation. The changes focus on optimizing the CI pipeline and cleaning up project documentation.
- Removed outdated Black code formatting documentation from CONTRIBUTING.md
- Added pip caching to the CI workflow to improve build performance
- Consolidated dependency installation commands in the CI workflow
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| CONTRIBUTING.md | Removes outdated Black formatting documentation |
| .github/workflows/ci.yml | Adds pip caching and consolidates dependency installation |
.github/workflows/ci.yml
Outdated
| uses: actions/cache@v4 | ||
| with: | ||
| path: ~/.cache/pip | ||
| key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ matrix.django-version }} |
There was a problem hiding this comment.
The cache key should include a hash of requirements files to ensure cache invalidation when dependencies change. Consider adding a hash of setup.py or requirements files to the key pattern.
Suggested change
| key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ matrix.django-version }} | |
| key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ matrix.django-version }}-${{ hashFiles('setup.py', 'requirements.txt', 'pyproject.toml') }} |
Copilot uses AI. Check for mistakes.
crccheck
commented
Aug 6, 2025
| uses: actions/cache@v4 | ||
| with: | ||
| path: ~/.cache/pip | ||
| key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ matrix.django-version }}-${{ hashFiles('pyproject.toml') }} |
There was a problem hiding this comment.
put the date in the key too. Deps are unpinned so I don't want cache to used most of the time
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.