copierz 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- copierz-0.1.0/LICENSE +202 -0
- copierz-0.1.0/PKG-INFO +181 -0
- copierz-0.1.0/README.md +166 -0
- copierz-0.1.0/pyproject.toml +92 -0
- copierz-0.1.0/pyproject.toml.orig +76 -0
- copierz-0.1.0/src/copierz/__init__.py +2 -0
- copierz-0.1.0/src/copierz/cli.py +739 -0
- copierz-0.1.0/src/copierz/config.py +79 -0
- copierz-0.1.0/src/copierz/discovery.py +134 -0
- copierz-0.1.0/src/copierz/git.py +387 -0
- copierz-0.1.0/src/copierz/lock.py +50 -0
- copierz-0.1.0/src/copierz/models.py +49 -0
- copierz-0.1.0/src/copierz/pusher.py +127 -0
- copierz-0.1.0/src/copierz/py.typed +0 -0
- copierz-0.1.0/src/copierz/stacks.py +159 -0
- copierz-0.1.0/src/copierz/status.py +191 -0
- copierz-0.1.0/src/copierz/template_source.py +106 -0
- copierz-0.1.0/src/copierz/updater.py +367 -0
copierz-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
copierz-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,181 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: copierz
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: CLI to track and apply Copier updates across a fleet of git repositories.
|
|
5
|
+
Author: m09
|
|
6
|
+
Author-email: m09 <142691+m09@users.noreply.github.com>
|
|
7
|
+
License-Expression: Apache-2.0
|
|
8
|
+
License-File: LICENSE
|
|
9
|
+
Requires-Dist: copier>=9.9,<10
|
|
10
|
+
Requires-Dist: packaging>=24
|
|
11
|
+
Requires-Dist: pyyaml>=6,<7
|
|
12
|
+
Requires-Dist: rich>=13
|
|
13
|
+
Requires-Python: >=3.13
|
|
14
|
+
Description-Content-Type: text/markdown
|
|
15
|
+
|
|
16
|
+
# `copierz`
|
|
17
|
+
|
|
18
|
+
A CLI to track the git repos — and every branch of them — generated from
|
|
19
|
+
[Copier](https://copier.readthedocs.io/) templates, see which are behind
|
|
20
|
+
their template, and bring them up to date in one go.
|
|
21
|
+
|
|
22
|
+
## Configuring
|
|
23
|
+
|
|
24
|
+
copierz reads `~/.config/copierz/config.toml` (or `$XDG_CONFIG_HOME`, or
|
|
25
|
+
`--config PATH`):
|
|
26
|
+
|
|
27
|
+
```toml
|
|
28
|
+
# Scanned recursively on every run.
|
|
29
|
+
roots = ["~/repos"]
|
|
30
|
+
|
|
31
|
+
# Repos (`path`) or single branches (`path@branch`) to leave alone.
|
|
32
|
+
exclude = ["~/repos/shuuchuu/old-thing", "*@backup/*"]
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Exclude entries take shell wildcards, `*` matching `/` too: `*@backup/*`
|
|
36
|
+
leaves out every `backup/` branch of every repo, which `update` would
|
|
37
|
+
otherwise bring up to date like any other.
|
|
38
|
+
|
|
39
|
+
There's no list of repos to maintain: on every run copierz scans the roots
|
|
40
|
+
for git repos, and every local branch of each (via `git show
|
|
41
|
+
branch:.copier-answers.yml`, no checkout needed) for a Copier answers file.
|
|
42
|
+
It stops descending at a repo, and skips hidden directories and linked
|
|
43
|
+
worktrees.
|
|
44
|
+
|
|
45
|
+
A branch can also carry Copier projects nested in subdirectories, each with
|
|
46
|
+
its own answers file (say a vendored `labs/`): each is tracked on its own,
|
|
47
|
+
shown as `branch:labs`, and gets an update commit of its own (`Update
|
|
48
|
+
template to 0.1.8 in labs`). Stacks are still made of branches: a stacked
|
|
49
|
+
branch is rebased once, whatever projects it carries. Exclude a nested
|
|
50
|
+
project with its path, `~/repos/slides/labs`. The template comes from each answers file's `_src_path`; a
|
|
51
|
+
relative one is resolved against the repo's own parent directory, which is
|
|
52
|
+
where `copier copy` is virtually always run from.
|
|
53
|
+
|
|
54
|
+
`--root PATH` (repeatable) scans other directories instead of the
|
|
55
|
+
configured roots.
|
|
56
|
+
|
|
57
|
+
## Usage
|
|
58
|
+
|
|
59
|
+
```console
|
|
60
|
+
$ copierz # same as `copierz status`
|
|
61
|
+
$ copierz status --fetch # git fetch every repo first
|
|
62
|
+
$ copierz update --all # update everything that's behind
|
|
63
|
+
$ copierz update ghcli # one repo (or REPO@BRANCH, a path, `.` for cwd)
|
|
64
|
+
$ copierz resolve # finish whatever stopped on conflicts
|
|
65
|
+
$ copierz continue # same, non-interactively, once fixed by hand
|
|
66
|
+
$ copierz abort ghcli@main # throw away a stopped update or rebase
|
|
67
|
+
$ copierz push --all --force # push what changed, rebased branches included
|
|
68
|
+
$ copierz log # template changes since the oldest version in use
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
`copierz update` commits every update that applies cleanly (`--no-commit`
|
|
72
|
+
to review them first, `--no-verify` to skip pre-commit hooks). A tracked
|
|
73
|
+
`uv.lock` is relocked into the update commit, since the template may have
|
|
74
|
+
changed `pyproject.toml`; if `uv lock` fails, the update is left
|
|
75
|
+
uncommitted, with uv's error, for you to fix and `copierz continue`. Anything
|
|
76
|
+
that stops on conflicts is left for `copierz resolve`, which walks each one
|
|
77
|
+
through your `git mergetool`, then offers to review the result in your
|
|
78
|
+
`git difftool` and commit it.
|
|
79
|
+
|
|
80
|
+
## Pushing
|
|
81
|
+
|
|
82
|
+
`copierz push` fetches, then pushes every selected branch that is ahead of
|
|
83
|
+
the remote branch it tracks. Branches rebased by `update` need `--force`;
|
|
84
|
+
they're then pushed with `--force-with-lease` on the fetched remote tip, and
|
|
85
|
+
only if that tip is in the branch's reflog — i.e. the remote holds nothing
|
|
86
|
+
the branch didn't have, so the force can't drop anyone else's work. Branches
|
|
87
|
+
behind or diverged from their remote are never pushed, and `--dry-run` shows
|
|
88
|
+
what would happen.
|
|
89
|
+
|
|
90
|
+
## Scripting and agents
|
|
91
|
+
|
|
92
|
+
`status`, `update`, `continue`, `abort`, `push` and `log` take `--json` to print a
|
|
93
|
+
single JSON document on stdout (errors go to stderr, exit code 2):
|
|
94
|
+
|
|
95
|
+
- `status --json`: `{"branches": [{repo, branch, subproject, template,
|
|
96
|
+
status, current, latest, parent, checkout, unmerged, detail}]}`, with
|
|
97
|
+
`subproject` `null` for the repo's root project, and `status`
|
|
98
|
+
one of `up_to_date`, `behind`, `blocked`, `in_progress`, `conflicts`,
|
|
99
|
+
`error`.
|
|
100
|
+
- `update --json` / `continue --json`: `{"outcomes": [{repo, branch,
|
|
101
|
+
subproject, outcome, checkout, detail}]}`, with `outcome` one of `updated`,
|
|
102
|
+
`rebased`, `uncommitted`, `conflicts`, `skipped`, `failed`. The exit code
|
|
103
|
+
is 1 if anything stopped (conflicts, uncommitted, failed).
|
|
104
|
+
- `abort --json --yes`: `{"aborted": [...]}`, same fields as `status`.
|
|
105
|
+
- `push --json`: `{"branches": [{repo, branch, state, remote, commits,
|
|
106
|
+
detail}]}`, with `state` one of `up_to_date`, `ahead`, `rewritten`,
|
|
107
|
+
`behind`, `diverged`, `no_upstream`. The exit code is 1 if a branch
|
|
108
|
+
couldn't be pushed.
|
|
109
|
+
- `log --json`: `{"templates": [{template, oldest, latest, commits: [{sha,
|
|
110
|
+
subject, refs}], in_use: {version: ["repo@branch", ...]}}]}`.
|
|
111
|
+
|
|
112
|
+
`resolve` is interactive; the non-interactive path is to edit the files
|
|
113
|
+
listed under `unmerged` in the `checkout` directory, `git add` them, and run
|
|
114
|
+
`copierz continue`.
|
|
115
|
+
|
|
116
|
+
## Stacked branches
|
|
117
|
+
|
|
118
|
+
Branches are often stacked: `solution` on `main`, `main-en` as a
|
|
119
|
+
translation commit on top of `main`, and so on, kept up to date by
|
|
120
|
+
rebasing. copierz detects this from the history: a branch is stacked on
|
|
121
|
+
another if it has commits of its own past their merge base, while the other
|
|
122
|
+
has none except template updates (commits touching the answers file). The
|
|
123
|
+
closest such branch is the parent; `copierz status` shows the stacks as a
|
|
124
|
+
tree.
|
|
125
|
+
|
|
126
|
+
A copy of a branch's own past tip (a backup, or a branch made from it with
|
|
127
|
+
no commits yet) looks just like a parent in the history, so copierz asks the
|
|
128
|
+
reflogs who got to that commit first: a copy arrives after the branch it
|
|
129
|
+
copies, while a child is created, reset or rebased onto its parent after the
|
|
130
|
+
parent got there. Reflogs expire (after 90 days by default), so `exclude`
|
|
131
|
+
backups you keep longer.
|
|
132
|
+
|
|
133
|
+
`copierz update` then only runs `copier update` on the bottom branch of each
|
|
134
|
+
stack, and rebases the branches above onto their parent once it's done.
|
|
135
|
+
Selecting any branch of a stack updates the whole stack. A branch that
|
|
136
|
+
stops on conflicts holds back the branches stacked on it, until `copierz
|
|
137
|
+
resolve` (or `continue`) finishes it and rebases them. During these rebases
|
|
138
|
+
the answers file follows the parent: a conflict there only comes from a
|
|
139
|
+
stale template update made on the branch itself, so it's resolved with the
|
|
140
|
+
parent's version, and a commit left empty by that is dropped. A `uv.lock`
|
|
141
|
+
conflict is resolved by relocking from the parent's lock, and a branch whose
|
|
142
|
+
lock is still stale once rebased (its own commits changed `pyproject.toml`)
|
|
143
|
+
gets a `Relock uv.lock` commit on top. Rebasing
|
|
144
|
+
rewrites those branches, so pushing them afterwards needs a force: see
|
|
145
|
+
`copierz push --force` below.
|
|
146
|
+
|
|
147
|
+
## Worktrees
|
|
148
|
+
|
|
149
|
+
copierz never switches your checkout to another branch, stashes, or
|
|
150
|
+
discards your changes. A branch checked out somewhere (your main checkout or
|
|
151
|
+
any worktree) is updated there, and only if it's clean. Any other branch is
|
|
152
|
+
updated in a temporary worktree under `~/.cache/copierz/worktrees/`, so a
|
|
153
|
+
dirty `main` doesn't hold back its siblings. That worktree is removed once
|
|
154
|
+
its branch is committed, and stays (its path is shown) while it has
|
|
155
|
+
conflicts to resolve.
|
|
156
|
+
|
|
157
|
+
## Statuses
|
|
158
|
+
|
|
159
|
+
- `up to date`: the branch's answers file records the template's latest
|
|
160
|
+
version (highest PEP 440 git tag, else `HEAD`, as Copier itself does).
|
|
161
|
+
- `behind`: an update is available; for a stacked branch, it'll come from
|
|
162
|
+
rebasing onto its parent.
|
|
163
|
+
- `behind, dirty`: the branch is checked out with uncommitted changes, so
|
|
164
|
+
it can't be updated until you commit or stash them.
|
|
165
|
+
- `conflicts`: an update or rebase stopped on conflicts; run `copierz
|
|
166
|
+
resolve`.
|
|
167
|
+
- `to commit`: an update was applied (or its conflicts resolved) but not
|
|
168
|
+
committed yet; run `copierz resolve`.
|
|
169
|
+
- `error`: the template can't be found or read.
|
|
170
|
+
|
|
171
|
+
Conflicts come out exactly as a `git merge` conflict would (Copier runs a
|
|
172
|
+
real 3-way `git merge-file` under the hood): conflict markers in the file,
|
|
173
|
+
and the file listed as unmerged by `git status`.
|
|
174
|
+
|
|
175
|
+
## Releasing
|
|
176
|
+
|
|
177
|
+
1. `uv run bumpver update --minor` (or `--patch`, `--major`): bumps, commits, tags
|
|
178
|
+
and pushes.
|
|
179
|
+
2. `uv run doit publish`: builds and uploads to PyPI with the token of
|
|
180
|
+
`creds.env`, a gitignored file at the repository's root holding one line,
|
|
181
|
+
`export UV_PUBLISH_TOKEN=pypi-...`, readable by you only (`chmod 400`).
|
copierz-0.1.0/README.md
ADDED
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
# `copierz`
|
|
2
|
+
|
|
3
|
+
A CLI to track the git repos — and every branch of them — generated from
|
|
4
|
+
[Copier](https://copier.readthedocs.io/) templates, see which are behind
|
|
5
|
+
their template, and bring them up to date in one go.
|
|
6
|
+
|
|
7
|
+
## Configuring
|
|
8
|
+
|
|
9
|
+
copierz reads `~/.config/copierz/config.toml` (or `$XDG_CONFIG_HOME`, or
|
|
10
|
+
`--config PATH`):
|
|
11
|
+
|
|
12
|
+
```toml
|
|
13
|
+
# Scanned recursively on every run.
|
|
14
|
+
roots = ["~/repos"]
|
|
15
|
+
|
|
16
|
+
# Repos (`path`) or single branches (`path@branch`) to leave alone.
|
|
17
|
+
exclude = ["~/repos/shuuchuu/old-thing", "*@backup/*"]
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Exclude entries take shell wildcards, `*` matching `/` too: `*@backup/*`
|
|
21
|
+
leaves out every `backup/` branch of every repo, which `update` would
|
|
22
|
+
otherwise bring up to date like any other.
|
|
23
|
+
|
|
24
|
+
There's no list of repos to maintain: on every run copierz scans the roots
|
|
25
|
+
for git repos, and every local branch of each (via `git show
|
|
26
|
+
branch:.copier-answers.yml`, no checkout needed) for a Copier answers file.
|
|
27
|
+
It stops descending at a repo, and skips hidden directories and linked
|
|
28
|
+
worktrees.
|
|
29
|
+
|
|
30
|
+
A branch can also carry Copier projects nested in subdirectories, each with
|
|
31
|
+
its own answers file (say a vendored `labs/`): each is tracked on its own,
|
|
32
|
+
shown as `branch:labs`, and gets an update commit of its own (`Update
|
|
33
|
+
template to 0.1.8 in labs`). Stacks are still made of branches: a stacked
|
|
34
|
+
branch is rebased once, whatever projects it carries. Exclude a nested
|
|
35
|
+
project with its path, `~/repos/slides/labs`. The template comes from each answers file's `_src_path`; a
|
|
36
|
+
relative one is resolved against the repo's own parent directory, which is
|
|
37
|
+
where `copier copy` is virtually always run from.
|
|
38
|
+
|
|
39
|
+
`--root PATH` (repeatable) scans other directories instead of the
|
|
40
|
+
configured roots.
|
|
41
|
+
|
|
42
|
+
## Usage
|
|
43
|
+
|
|
44
|
+
```console
|
|
45
|
+
$ copierz # same as `copierz status`
|
|
46
|
+
$ copierz status --fetch # git fetch every repo first
|
|
47
|
+
$ copierz update --all # update everything that's behind
|
|
48
|
+
$ copierz update ghcli # one repo (or REPO@BRANCH, a path, `.` for cwd)
|
|
49
|
+
$ copierz resolve # finish whatever stopped on conflicts
|
|
50
|
+
$ copierz continue # same, non-interactively, once fixed by hand
|
|
51
|
+
$ copierz abort ghcli@main # throw away a stopped update or rebase
|
|
52
|
+
$ copierz push --all --force # push what changed, rebased branches included
|
|
53
|
+
$ copierz log # template changes since the oldest version in use
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
`copierz update` commits every update that applies cleanly (`--no-commit`
|
|
57
|
+
to review them first, `--no-verify` to skip pre-commit hooks). A tracked
|
|
58
|
+
`uv.lock` is relocked into the update commit, since the template may have
|
|
59
|
+
changed `pyproject.toml`; if `uv lock` fails, the update is left
|
|
60
|
+
uncommitted, with uv's error, for you to fix and `copierz continue`. Anything
|
|
61
|
+
that stops on conflicts is left for `copierz resolve`, which walks each one
|
|
62
|
+
through your `git mergetool`, then offers to review the result in your
|
|
63
|
+
`git difftool` and commit it.
|
|
64
|
+
|
|
65
|
+
## Pushing
|
|
66
|
+
|
|
67
|
+
`copierz push` fetches, then pushes every selected branch that is ahead of
|
|
68
|
+
the remote branch it tracks. Branches rebased by `update` need `--force`;
|
|
69
|
+
they're then pushed with `--force-with-lease` on the fetched remote tip, and
|
|
70
|
+
only if that tip is in the branch's reflog — i.e. the remote holds nothing
|
|
71
|
+
the branch didn't have, so the force can't drop anyone else's work. Branches
|
|
72
|
+
behind or diverged from their remote are never pushed, and `--dry-run` shows
|
|
73
|
+
what would happen.
|
|
74
|
+
|
|
75
|
+
## Scripting and agents
|
|
76
|
+
|
|
77
|
+
`status`, `update`, `continue`, `abort`, `push` and `log` take `--json` to print a
|
|
78
|
+
single JSON document on stdout (errors go to stderr, exit code 2):
|
|
79
|
+
|
|
80
|
+
- `status --json`: `{"branches": [{repo, branch, subproject, template,
|
|
81
|
+
status, current, latest, parent, checkout, unmerged, detail}]}`, with
|
|
82
|
+
`subproject` `null` for the repo's root project, and `status`
|
|
83
|
+
one of `up_to_date`, `behind`, `blocked`, `in_progress`, `conflicts`,
|
|
84
|
+
`error`.
|
|
85
|
+
- `update --json` / `continue --json`: `{"outcomes": [{repo, branch,
|
|
86
|
+
subproject, outcome, checkout, detail}]}`, with `outcome` one of `updated`,
|
|
87
|
+
`rebased`, `uncommitted`, `conflicts`, `skipped`, `failed`. The exit code
|
|
88
|
+
is 1 if anything stopped (conflicts, uncommitted, failed).
|
|
89
|
+
- `abort --json --yes`: `{"aborted": [...]}`, same fields as `status`.
|
|
90
|
+
- `push --json`: `{"branches": [{repo, branch, state, remote, commits,
|
|
91
|
+
detail}]}`, with `state` one of `up_to_date`, `ahead`, `rewritten`,
|
|
92
|
+
`behind`, `diverged`, `no_upstream`. The exit code is 1 if a branch
|
|
93
|
+
couldn't be pushed.
|
|
94
|
+
- `log --json`: `{"templates": [{template, oldest, latest, commits: [{sha,
|
|
95
|
+
subject, refs}], in_use: {version: ["repo@branch", ...]}}]}`.
|
|
96
|
+
|
|
97
|
+
`resolve` is interactive; the non-interactive path is to edit the files
|
|
98
|
+
listed under `unmerged` in the `checkout` directory, `git add` them, and run
|
|
99
|
+
`copierz continue`.
|
|
100
|
+
|
|
101
|
+
## Stacked branches
|
|
102
|
+
|
|
103
|
+
Branches are often stacked: `solution` on `main`, `main-en` as a
|
|
104
|
+
translation commit on top of `main`, and so on, kept up to date by
|
|
105
|
+
rebasing. copierz detects this from the history: a branch is stacked on
|
|
106
|
+
another if it has commits of its own past their merge base, while the other
|
|
107
|
+
has none except template updates (commits touching the answers file). The
|
|
108
|
+
closest such branch is the parent; `copierz status` shows the stacks as a
|
|
109
|
+
tree.
|
|
110
|
+
|
|
111
|
+
A copy of a branch's own past tip (a backup, or a branch made from it with
|
|
112
|
+
no commits yet) looks just like a parent in the history, so copierz asks the
|
|
113
|
+
reflogs who got to that commit first: a copy arrives after the branch it
|
|
114
|
+
copies, while a child is created, reset or rebased onto its parent after the
|
|
115
|
+
parent got there. Reflogs expire (after 90 days by default), so `exclude`
|
|
116
|
+
backups you keep longer.
|
|
117
|
+
|
|
118
|
+
`copierz update` then only runs `copier update` on the bottom branch of each
|
|
119
|
+
stack, and rebases the branches above onto their parent once it's done.
|
|
120
|
+
Selecting any branch of a stack updates the whole stack. A branch that
|
|
121
|
+
stops on conflicts holds back the branches stacked on it, until `copierz
|
|
122
|
+
resolve` (or `continue`) finishes it and rebases them. During these rebases
|
|
123
|
+
the answers file follows the parent: a conflict there only comes from a
|
|
124
|
+
stale template update made on the branch itself, so it's resolved with the
|
|
125
|
+
parent's version, and a commit left empty by that is dropped. A `uv.lock`
|
|
126
|
+
conflict is resolved by relocking from the parent's lock, and a branch whose
|
|
127
|
+
lock is still stale once rebased (its own commits changed `pyproject.toml`)
|
|
128
|
+
gets a `Relock uv.lock` commit on top. Rebasing
|
|
129
|
+
rewrites those branches, so pushing them afterwards needs a force: see
|
|
130
|
+
`copierz push --force` below.
|
|
131
|
+
|
|
132
|
+
## Worktrees
|
|
133
|
+
|
|
134
|
+
copierz never switches your checkout to another branch, stashes, or
|
|
135
|
+
discards your changes. A branch checked out somewhere (your main checkout or
|
|
136
|
+
any worktree) is updated there, and only if it's clean. Any other branch is
|
|
137
|
+
updated in a temporary worktree under `~/.cache/copierz/worktrees/`, so a
|
|
138
|
+
dirty `main` doesn't hold back its siblings. That worktree is removed once
|
|
139
|
+
its branch is committed, and stays (its path is shown) while it has
|
|
140
|
+
conflicts to resolve.
|
|
141
|
+
|
|
142
|
+
## Statuses
|
|
143
|
+
|
|
144
|
+
- `up to date`: the branch's answers file records the template's latest
|
|
145
|
+
version (highest PEP 440 git tag, else `HEAD`, as Copier itself does).
|
|
146
|
+
- `behind`: an update is available; for a stacked branch, it'll come from
|
|
147
|
+
rebasing onto its parent.
|
|
148
|
+
- `behind, dirty`: the branch is checked out with uncommitted changes, so
|
|
149
|
+
it can't be updated until you commit or stash them.
|
|
150
|
+
- `conflicts`: an update or rebase stopped on conflicts; run `copierz
|
|
151
|
+
resolve`.
|
|
152
|
+
- `to commit`: an update was applied (or its conflicts resolved) but not
|
|
153
|
+
committed yet; run `copierz resolve`.
|
|
154
|
+
- `error`: the template can't be found or read.
|
|
155
|
+
|
|
156
|
+
Conflicts come out exactly as a `git merge` conflict would (Copier runs a
|
|
157
|
+
real 3-way `git merge-file` under the hood): conflict markers in the file,
|
|
158
|
+
and the file listed as unmerged by `git status`.
|
|
159
|
+
|
|
160
|
+
## Releasing
|
|
161
|
+
|
|
162
|
+
1. `uv run bumpver update --minor` (or `--patch`, `--major`): bumps, commits, tags
|
|
163
|
+
and pushes.
|
|
164
|
+
2. `uv run doit publish`: builds and uploads to PyPI with the token of
|
|
165
|
+
`creds.env`, a gitignored file at the repository's root holding one line,
|
|
166
|
+
`export UV_PUBLISH_TOKEN=pypi-...`, readable by you only (`chmod 400`).
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
dependencies = [
|
|
3
|
+
"copier >= 9.9, < 10",
|
|
4
|
+
"packaging >= 24",
|
|
5
|
+
"pyyaml >= 6, < 7",
|
|
6
|
+
"rich >= 13",
|
|
7
|
+
]
|
|
8
|
+
description = "CLI to track and apply Copier updates across a fleet of git repositories."
|
|
9
|
+
homepage = "https://github.com/shuuchuu/copierz"
|
|
10
|
+
license = "Apache-2.0"
|
|
11
|
+
license-files = ["LICENSE"]
|
|
12
|
+
name = "copierz"
|
|
13
|
+
readme = "README.md"
|
|
14
|
+
requires-python = ">= 3.13"
|
|
15
|
+
version = "0.1.0"
|
|
16
|
+
|
|
17
|
+
[[project.authors]]
|
|
18
|
+
name = "m09"
|
|
19
|
+
email = "142691+m09@users.noreply.github.com"
|
|
20
|
+
|
|
21
|
+
[project.scripts]
|
|
22
|
+
copierz = "copierz.cli:main"
|
|
23
|
+
|
|
24
|
+
[dependency-groups]
|
|
25
|
+
dev = [
|
|
26
|
+
"bumpver >= 2026.1132",
|
|
27
|
+
"doit >= 0.37",
|
|
28
|
+
"prek >= 0.5.7",
|
|
29
|
+
"pyrefly >= 1.4",
|
|
30
|
+
"pytest >= 9",
|
|
31
|
+
"ruff >= 0.17",
|
|
32
|
+
]
|
|
33
|
+
|
|
34
|
+
[tool.ruff]
|
|
35
|
+
target-version = "py313"
|
|
36
|
+
|
|
37
|
+
[tool.ruff.lint]
|
|
38
|
+
ignore = [
|
|
39
|
+
"D1",
|
|
40
|
+
"incorrect-blank-line-before-class",
|
|
41
|
+
"multi-line-summary-second-line",
|
|
42
|
+
"non-empty-init-module",
|
|
43
|
+
]
|
|
44
|
+
preview = true
|
|
45
|
+
select = [
|
|
46
|
+
"A",
|
|
47
|
+
"B",
|
|
48
|
+
"C",
|
|
49
|
+
"D",
|
|
50
|
+
"DOC",
|
|
51
|
+
"E",
|
|
52
|
+
"EM",
|
|
53
|
+
"F",
|
|
54
|
+
"I",
|
|
55
|
+
"N",
|
|
56
|
+
"PIE",
|
|
57
|
+
"PTH",
|
|
58
|
+
"RET",
|
|
59
|
+
"RUF",
|
|
60
|
+
"SIM",
|
|
61
|
+
"SLF",
|
|
62
|
+
"TC",
|
|
63
|
+
"UP",
|
|
64
|
+
"W",
|
|
65
|
+
]
|
|
66
|
+
|
|
67
|
+
[tool.ruff.lint.pydocstyle]
|
|
68
|
+
convention = "google"
|
|
69
|
+
|
|
70
|
+
[tool.pyrefly]
|
|
71
|
+
search-path = ["."]
|
|
72
|
+
|
|
73
|
+
[bumpver]
|
|
74
|
+
commit = true
|
|
75
|
+
tag = true
|
|
76
|
+
push = true
|
|
77
|
+
commit_message = "Bump version to {new_version}"
|
|
78
|
+
current_version = "0.1.0"
|
|
79
|
+
pre_commit_hook = "scripts/bumpver_pre_commit.sh"
|
|
80
|
+
tag_message = "{new_version}"
|
|
81
|
+
version_pattern = "MAJOR.MINOR.PATCH"
|
|
82
|
+
|
|
83
|
+
[bumpver.file_patterns]
|
|
84
|
+
"pyproject.toml" = [
|
|
85
|
+
'^version = "{version}"$',
|
|
86
|
+
'^current_version = "{version}"$',
|
|
87
|
+
]
|
|
88
|
+
"src/copierz/__init__.py" = ['^__version__ = "{version}"$']
|
|
89
|
+
|
|
90
|
+
[build-system]
|
|
91
|
+
build-backend = "uv_build"
|
|
92
|
+
requires = ["uv_build>=0.13.6,<0.14.0"]
|