Skip to content

Commit 36eb592

Browse files
gilesknapcoretlGDYendell
authored
add recommended workflow for copier updates (#214)
Add recommended workflow for copier updates Co-authored-by: Gary Yendell <gary.yendell@diamond.ac.uk> --------- Co-authored-by: Tom C (DLS) <101418278+coretl@users.noreply.github.com> Co-authored-by: Gary Yendell <gary.yendell@diamond.ac.uk>
1 parent 0f64ce8 commit 36eb592

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

docs/how-to/update-template.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# How to update to the latest template structure
22

3+
## Overview
4+
35
To track changes to the upstream template, run
46

57
```
@@ -15,3 +17,24 @@ git diff --check
1517
```
1618

1719
Once they are all fixed, make a commit.
20+
21+
## Recommended Workflow
22+
23+
The following steps are recommended to update your project, especially for infrequently updated projects:
24+
25+
- first make sure all the tools are updated to latest versions
26+
- for devcontainers
27+
- `ctrl+shift+p` -> `Remote-Containers: Rebuild Without Cache and Reopen in Container`
28+
- for local development
29+
- `pip install -e .[dev] --force-reinstall`
30+
- validate your project against the latest tools
31+
- `tox -p`
32+
- fix issues found by the above
33+
- commit the changes
34+
- update the template
35+
- `copier update --trust`
36+
- fix any merge conflicts
37+
- validate that the project still works
38+
- `tox -p`
39+
- fix any issues found by the above
40+
- commit the changes

0 commit comments

Comments
 (0)