Update uv.lock, remove lockfile workflow, update CONTRIBUTING with dependency guidance
This commit is contained in:
42
.github/workflows/update-lockfile.yaml
vendored
42
.github/workflows/update-lockfile.yaml
vendored
@@ -1,42 +0,0 @@
|
|||||||
name: Update lockfile
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
paths:
|
|
||||||
- 'pyproject.toml'
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
workflow_dispatch: # Allows manual triggering from GitHub UI
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
update-lockfile:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
# This gives the workflow permission to push back to the repo
|
|
||||||
token: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
|
|
||||||
- name: Install uv
|
|
||||||
uses: astral-sh/setup-uv@v1
|
|
||||||
|
|
||||||
- name: Update lockfile
|
|
||||||
run: uv lock
|
|
||||||
|
|
||||||
- name: Check for changes
|
|
||||||
id: verify-changed-files
|
|
||||||
run: |
|
|
||||||
if [ -n "$(git status --porcelain)" ]; then
|
|
||||||
echo "changed=true" >> $GITHUB_OUTPUT
|
|
||||||
else
|
|
||||||
echo "changed=false" >> $GITHUB_OUTPUT
|
|
||||||
fi
|
|
||||||
|
|
||||||
- name: Commit lockfile
|
|
||||||
if: steps.verify-changed-files.outputs.changed == 'true'
|
|
||||||
run: |
|
|
||||||
git config --local user.email "action@github.com"
|
|
||||||
git config --local user.name "GitHub Action"
|
|
||||||
git add uv.lock
|
|
||||||
git commit -m "chore: update uv.lock after dependency changes"
|
|
||||||
git push
|
|
||||||
@@ -31,6 +31,23 @@ git push origin your-branch-name
|
|||||||
|
|
||||||
Our maintainers will review your PR, and once everything is good, your contributions will be merged!
|
Our maintainers will review your PR, and once everything is good, your contributions will be merged!
|
||||||
|
|
||||||
|
## Dependency Management
|
||||||
|
|
||||||
|
This project uses [uv](https://docs.astral.sh/uv/) for dependency management. The `uv.lock` file is committed to ensure reproducible builds.
|
||||||
|
|
||||||
|
### Adding or Updating Dependencies
|
||||||
|
|
||||||
|
1. Edit `pyproject.toml` to add/update dependencies
|
||||||
|
2. Run `uv lock` to update the lockfile with new dependency resolution
|
||||||
|
3. Run `uv sync` to install the updated dependencies locally
|
||||||
|
4. Always commit both files together:
|
||||||
|
```bash
|
||||||
|
git add pyproject.toml uv.lock
|
||||||
|
git commit -m "feat: add new dependency for feature X"
|
||||||
|
```
|
||||||
|
|
||||||
|
**Important:** Never manually edit `uv.lock`. It's auto-generated by `uv lock`.
|
||||||
|
|
||||||
## Code Style and Documentation
|
## Code Style and Documentation
|
||||||
|
|
||||||
### Python Code Style
|
### Python Code Style
|
||||||
|
|||||||
Reference in New Issue
Block a user