Skip to content

Commit 899a191

Browse files
committed
Add paragraph about automated updates
1 parent a76656a commit 899a191

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

Diff for: docs/maintainer-guide.md

+12-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,17 @@
22

33
This document is intended for maintainers of the template.
44

5+
## Automated updates
6+
7+
We use 2 separate services to keep our dependencies up-to-date:
8+
9+
- Dependabot, which manages updates of Python deps of the template, GitHub actions, npm packages and Docker images.
10+
- PyUp, which manages the Python deps for the generated project.
11+
12+
We don't use Dependabot for the generated project deps because our requirements files are templated, and Dependabot fails to parse them. PyUp is -AFAIK- the only service out there that supports having Jinja tags in the requirements file.
13+
14+
Updates for the template should be labelled as `project infrastructure` while the ones about the generated project should be labelled as `update`. This is use to work in conjunction with our changelog script (see later).
15+
516
## Automation scripts
617

718
We have a few workflows which have been automated over time. They usually run using GitHub actions and might need a few small manual actions to work nicely. Some have a few limitations which we should document here.
@@ -78,8 +89,8 @@ With that in mind, when merging changes, it's a good idea to set the labels and
7889

7990
#### Limitations
8091

81-
- Dependencies updates for the template repo (tox, cookiecutter, etc...) don't need to appear in changelog, and need to be labelled as `project infrastructure` manually. By default, they come from PyUp labelled as `update`.
8292
- Dependabot updates for npm & Docker have a verbose title, try to rename them to be more readable: `Bump webpack-dev-server from 4.15.1 to 5.0.2 in /{{cookiecutter.project_slug}}` -> `Bump webpack-dev-server to 5.0.2`
93+
- ~~Dependencies updates for the template repo (tox, cookiecutter, etc...) don't need to appear in changelog, and need to be labelled as `project infrastructure` manually. By default, they come from PyUp labelled as `update`.~~
8394

8495
### Update contributors
8596

0 commit comments

Comments
 (0)