Mirror of https://github.com/roostorg/osprey
github.com/roostorg/osprey
Add uv lock freeze command (#198)
Signed-off-by: Chihurumnaya Ibiam <ibiamchihurumnaya@gmail.com>
Co-authored-by: Cassidy James Blaede <cassidyjames@roost.tools>
authored by
Ibiam Chihurumnaya
Cassidy James Blaede
and committed by
GitHub
d750b936
b6706a7f
+51
-42
+51
-42
docs/development/workflow.md
+51
-42
docs/development/workflow.md
···
17
17
3. **YAML/JSON/TOML validation**
18
18
4. **Ruff linting and formatting**
19
19
20
-
### Manual Checks
20
+
## Making Changes
21
+
22
+
1. **Sync Dependencies**
23
+
```bash
24
+
uv sync --frozen
25
+
```
26
+
27
+
2. **Create a new branch:**
28
+
29
+
```bash
30
+
git checkout -b username/feature-name
31
+
```
32
+
33
+
3. **Make your changes**
34
+
35
+
4. **Run quality checks:**
36
+
37
+
```bash
38
+
# This prevents uv.lock from being modified
39
+
# this is preferred.
40
+
uv sync --frozen
41
+
42
+
uv run ruff check --fix
43
+
uv run ruff format
44
+
```
21
45
22
-
Before pushing, run:
46
+
5. **Test your changes** (if tests exist)
23
47
24
-
```bash
25
-
# Comprehensive linting check
26
-
uv run ruff check
48
+
6. **Commit your changes:**
49
+
50
+
```bash
51
+
git add .
52
+
git commit -m "feat: descriptive commit message"
53
+
```
27
54
28
-
# Format all code
29
-
uv run ruff format
55
+
Pre-commit hooks will run automatically and may fix formatting issues.
30
56
31
-
# Type checking (on specific files/modules)
32
-
uv run mypy osprey_worker/src/osprey_worker/lib
33
-
# Or you can type check every module (this will happen in CI)
34
-
uv run mypy .
57
+
7. **Push your branch:**
35
58
36
-
# Run all pre-commit hooks
37
-
uv run pre-commit run --all-files
38
-
```
59
+
```bash
60
+
git push origin username/feature-name
61
+
```
39
62
40
63
## Commit Standards
41
64
···
57
80
- `test:` - Adding or updating tests
58
81
- `chore:` - Maintenance tasks
59
82
60
-
## Making Changes
61
-
62
-
1. **Create a new branch:**
63
-
64
-
```bash
65
-
git checkout -b username/feature-name
66
-
```
67
-
68
-
2. **Make your changes**
69
-
70
-
3. **Run quality checks:**
71
-
72
-
```bash
73
-
uv run ruff check --fix
74
-
uv run ruff format
75
-
```
76
-
77
-
4. **Test your changes** (if tests exist)
83
+
### Manual Checks
78
84
79
-
5. **Commit your changes:**
85
+
Before pushing, run:
80
86
81
-
```bash
82
-
git add .
83
-
git commit -m "feat: descriptive commit message"
84
-
```
87
+
```bash
88
+
# Comprehensive linting check
89
+
uv run ruff check
85
90
86
-
Pre-commit hooks will run automatically and may fix formatting issues.
91
+
# Format all code
92
+
uv run ruff format
87
93
88
-
6. **Push your branch:**
94
+
# Type checking (on specific files/modules)
95
+
uv run mypy osprey_worker/src/osprey_worker/lib
96
+
# Or you can type check every module (this will happen in CI)
97
+
uv run mypy .
89
98
90
-
```bash
91
-
git push origin username/feature-name
92
-
```
99
+
# Run all pre-commit hooks
100
+
uv run pre-commit run --all-files
101
+
```