Skip to content

Commit 5b220b0

Browse files
committed
Fix naming inconsistency
1 parent 3128f08 commit 5b220b0

File tree

6 files changed

+23
-19
lines changed

6 files changed

+23
-19
lines changed

docs/changelog.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,11 @@ and this project adheres to [Effort-based Versioning](https://jacobtomlinson.dev
1010

1111
## [Unreleased][]
1212

13-
(no changes yet)
13+
(no summary yet)
14+
15+
### Changed
16+
17+
- Rename `wrap_git` action to `wrap-git` for consistency with other StepUp actions.
1418

1519
## [3.1.4][] - 2025-10-18 {: v3.1.4 }
1620

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ raster-pdf = "stepup.reprep.actions:raster_pdf"
9898
bibsane = "stepup.reprep.actions:bibsane"
9999
sync-zenodo = "stepup.reprep.actions:sync_zenodo"
100100
unplot = "stepup.reprep.actions:unplot"
101-
wrap_git = "stepup.reprep.actions:wrap_git"
101+
wrap-git = "stepup.reprep.actions:wrap_git"
102102
zip-inventory = "stepup.reprep.actions:zip_inventory"
103103

104104
[tool.pytest.ini_options]

stepup/reprep/api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1327,7 +1327,7 @@ def wrap_git(
13271327
if not (out is None or isinstance(out, str)):
13281328
raise TypeError("The output of the git command must be a string or None.")
13291329

1330-
action = "wrap_git"
1330+
action = "wrap-git"
13311331
if out is not None:
13321332
action += f" --out={shlex.quote(out)}"
13331333
action += f" -- {command}"

tests/examples/wrap_git/expected_graph_1.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ file:./
1010
supplies file:gitlog.txt
1111
supplies file:plan.py
1212
supplies step:runpy ./plan.py
13-
supplies step:wrap_git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
13+
supplies step:wrap-git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
1414

1515
file:plan.py
1616
state = STATIC
@@ -25,7 +25,7 @@ step:runpy ./plan.py
2525
consumes file:./
2626
consumes file:plan.py
2727
creates dg:.git/**
28-
creates step:wrap_git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
28+
creates step:wrap-git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
2929

3030
dg:.git/**
3131
created by step:runpy ./plan.py
@@ -35,7 +35,7 @@ dg:.git/**
3535
creates file:.git/refs/heads/
3636
creates file:.git/refs/heads/main
3737

38-
step:wrap_git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
38+
step:wrap-git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
3939
state = SUCCEEDED
4040
created by step:runpy ./plan.py
4141
consumes file:./
@@ -46,15 +46,15 @@ step:wrap_git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
4646

4747
file:gitlog.txt
4848
state = BUILT
49-
created by step:wrap_git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
49+
created by step:wrap-git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
5050
consumes file:./
51-
consumes step:wrap_git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
51+
consumes step:wrap-git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
5252

5353
file:.git/HEAD
5454
state = STATIC
5555
created by dg:.git/**
5656
consumes file:.git/
57-
supplies step:wrap_git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
57+
supplies step:wrap-git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
5858

5959
file:.git/
6060
state = STATIC
@@ -67,7 +67,7 @@ file:.git/refs/heads/main
6767
state = STATIC
6868
created by dg:.git/**
6969
consumes file:.git/refs/heads/
70-
supplies step:wrap_git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
70+
supplies step:wrap-git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
7171

7272
file:.git/refs/heads/
7373
state = STATIC

tests/examples/wrap_git/expected_graph_2.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ file:./
1010
supplies file:gitlog.txt
1111
supplies file:plan.py
1212
supplies step:runpy ./plan.py
13-
supplies step:wrap_git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
13+
supplies step:wrap-git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
1414

1515
file:plan.py
1616
state = STATIC
@@ -25,7 +25,7 @@ step:runpy ./plan.py
2525
consumes file:./
2626
consumes file:plan.py
2727
creates dg:.git/**
28-
creates step:wrap_git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
28+
creates step:wrap-git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
2929

3030
dg:.git/**
3131
created by step:runpy ./plan.py
@@ -35,7 +35,7 @@ dg:.git/**
3535
creates file:.git/refs/heads/
3636
creates file:.git/refs/heads/main
3737

38-
step:wrap_git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
38+
step:wrap-git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
3939
state = SUCCEEDED
4040
created by step:runpy ./plan.py
4141
consumes file:./
@@ -46,15 +46,15 @@ step:wrap_git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
4646

4747
file:gitlog.txt
4848
state = BUILT
49-
created by step:wrap_git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
49+
created by step:wrap-git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
5050
consumes file:./
51-
consumes step:wrap_git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
51+
consumes step:wrap-git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
5252

5353
file:.git/HEAD
5454
state = STATIC
5555
created by dg:.git/**
5656
consumes file:.git/
57-
supplies step:wrap_git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
57+
supplies step:wrap-git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
5858

5959
file:.git/
6060
state = STATIC
@@ -67,7 +67,7 @@ file:.git/refs/heads/main
6767
state = STATIC
6868
created by dg:.git/**
6969
consumes file:.git/refs/heads/
70-
supplies step:wrap_git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
70+
supplies step:wrap-git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
7171

7272
file:.git/refs/heads/
7373
state = STATIC

tests/examples/wrap_git/expected_stdout_1.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
0/1 | PHASE │ run
44
0/1 | START │ runpy ./plan.py
55
1/2 | SUCCESS │ runpy ./plan.py
6-
1/2 | START │ wrap_git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
7-
2/2 | SUCCESS │ wrap_git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
6+
1/2 | START │ wrap-git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
7+
2/2 | SUCCESS │ wrap-git --out=gitlog.txt -- git log -n1 --pretty='format:%cs (%h)'
88
2/2 | DIRECTOR │ Trying to delete 0 outdated output(s)
99
2/2 | PHASE │ watch
1010
2/2 | DIRECTOR │ Stopping workers

0 commit comments

Comments
 (0)