From 53620c103746bd29c5816f6bf80e1b85ba3d963d Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Mon, 18 Nov 2024 14:13:51 +0000 Subject: [PATCH 1/3] add recommended workflow for copier updates --- docs/how-to/update-template.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/docs/how-to/update-template.md b/docs/how-to/update-template.md index b7162771..e5806de6 100644 --- a/docs/how-to/update-template.md +++ b/docs/how-to/update-template.md @@ -1,5 +1,7 @@ # How to update to the latest template structure +## Overview + To track changes to the upstream template, run ``` @@ -15,3 +17,24 @@ git diff --check ``` Once they are all fixed, make a commit. + +## Recommended Workflow + +The following steps are recommended to update your project, especially for infreqently updated projects: + +- first make sure all the tools are updated to latest versions + - for devcontainers + - `ctrl+shift+p` -> `Remote-Containers: Rebuild Without Cache and Reopen in Container` + - for local development + - `pip install -e .[dev] --force-reinstall` +- validate your project agains the latest tools + - `tox -p` +- fix issues found by the above +- commit the changes +- update the template + - `copier update --trust` +- fix any merge conflicts +- validate that the project still works + - `tox -p` +- fix any issues found by the above +- commit the changes From 01f7b1881da9f03e83e2cfd4b56526688f36243b Mon Sep 17 00:00:00 2001 From: Giles Knap Date: Mon, 18 Nov 2024 16:05:49 +0000 Subject: [PATCH 2/3] typo --- docs/how-to/update-template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to/update-template.md b/docs/how-to/update-template.md index e5806de6..46772683 100644 --- a/docs/how-to/update-template.md +++ b/docs/how-to/update-template.md @@ -27,7 +27,7 @@ The following steps are recommended to update your project, especially for infre - `ctrl+shift+p` -> `Remote-Containers: Rebuild Without Cache and Reopen in Container` - for local development - `pip install -e .[dev] --force-reinstall` -- validate your project agains the latest tools +- validate your project against the latest tools - `tox -p` - fix issues found by the above - commit the changes From 49604f74973dd08450e99a9e09a20c9791d4ceaf Mon Sep 17 00:00:00 2001 From: "Tom C (DLS)" <101418278+coretl@users.noreply.github.com> Date: Wed, 20 Nov 2024 11:25:12 +0000 Subject: [PATCH 3/3] Update docs/how-to/update-template.md Co-authored-by: Gary Yendell --- docs/how-to/update-template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to/update-template.md b/docs/how-to/update-template.md index 46772683..cfb5829b 100644 --- a/docs/how-to/update-template.md +++ b/docs/how-to/update-template.md @@ -20,7 +20,7 @@ Once they are all fixed, make a commit. ## Recommended Workflow -The following steps are recommended to update your project, especially for infreqently updated projects: +The following steps are recommended to update your project, especially for infrequently updated projects: - first make sure all the tools are updated to latest versions - for devcontainers