Skip to content
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/how-to/update-template.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# How to update to the latest template structure

## Overview

To track changes to the upstream template, run

```
Expand All @@ -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 against 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