Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add recommended workflow for copier updates #214

Merged
merged 3 commits into from
Nov 20, 2024
Merged

add recommended workflow for copier updates #214

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
53620c1
add recommended workflow for copier updates
gilesknap Nov 18, 2024
01f7b18
typo
gilesknap Nov 18, 2024
49604f7
Update docs/how-to/update-template.md
coretl Nov 20, 2024
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
View file
Open in desktop
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 infrequently 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
Loading