Skip to content

chore: project maintenance #186

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

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

chore: project maintenance #186

wants to merge 4 commits into from

Conversation

crccheck
Copy link
Owner

@crccheck crccheck commented Aug 6, 2025

No description provided.

@crccheck crccheck changed the title Maintenance chore: project maintenance Aug 6, 2025
@crccheck crccheck requested a review from Copilot August 6, 2025 06:12
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

uses: actions/cache@v4
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ matrix.django-version }}
Copy link
Preview

Copilot AI Aug 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

uses: actions/cache@v4
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ matrix.django-version }}-${{ hashFiles('pyproject.toml') }}
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant