Skip to content

Commit 2266853

Browse files
committed
Add Upgrade notes
1 parent 4a4a4c1 commit 2266853

File tree

2 files changed

+73
-22
lines changed

2 files changed

+73
-22
lines changed

CHANGELOG.md

Lines changed: 3 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,7 @@
5353
* Go 1.13.5
5454
* Seconds field optional for schedule
5555

56-
> :warning: **BREAKING CHANGES**<br />
57-
> `image` field has been moved to `providers.static` in configuration file.<br />
58-
> See [providers configuration](doc/configuration.md#providers) for more info.
56+
> :warning: See [**UPGRADE NOTES**](UPGRADE.md#1x--2x) for breaking changes.
5957
6058
## 1.4.1 (2019/10/20)
6159

@@ -66,20 +64,10 @@
6664

6765
* Multi-platform Docker image
6866
* Switch to GitHub Actions
69-
* :warning: Run Docker container as non-root user
70-
* :warning: Stop publishing Docker image on Quay
67+
* Stop publishing Docker image on Quay
7168
* Go 1.12.10
7269
* Use GOPROXY
7370

74-
> :warning: **UPGRADE NOTES**
75-
> As the Docker container now runs as a non-root user, you have to first stop the container and change permissions to `data` volume:
76-
> ```
77-
> docker-compose stop
78-
> chown -R 1000:1000 data/
79-
> docker-compose pull
80-
> docker-compose up -d
81-
> ```
82-
8371
## 1.3.0 (2019/08/22)
8472

8573
* Add Linux service doc and sample
@@ -116,14 +104,7 @@
116104
* Review config file structure
117105
* Improve worker pool
118106

119-
> :warning: **BREAKING CHANGES**
120-
> Some fields in configuration file has been changed:
121-
> * `registries` renamed `regopts`
122-
> * `items` renamed `image`
123-
> * `items[].image` renamed `image[].name`
124-
> * `items[].registry_id` renamed `image[].regopts_id`
125-
> * `watch.os` and `watch.arch` moved to `image[].os` and `image[].arch`
126-
> See README for more info.
107+
> :warning: See [**UPGRADE NOTES**](UPGRADE.md#0x--1x) for breaking changes.
127108
128109
## 0.5.0 (2019/06/09)
129110

UPGRADE.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Upgrade notes
2+
3+
## 2.x > 3.x
4+
5+
6+
7+
## 1.x > 2.x
8+
9+
`image` field has been moved to `providers.static` in configuration file:
10+
11+
> **1.x**
12+
```yaml
13+
image:
14+
- name: docker.io/crazymax/diun
15+
watch_repo: true
16+
max_tags: 10
17+
```
18+
19+
> **2.x**
20+
```yaml
21+
providers:
22+
static:
23+
- name: docker.io/crazymax/diun
24+
watch_repo: true
25+
max_tags: 10
26+
```
27+
28+
See [providers configuration](doc/configuration.md#providers) for more info.
29+
30+
## 0.x > 1.x
31+
32+
Some fields in configuration file has been changed:
33+
34+
* `registries` renamed `regopts`
35+
* `items` renamed `image`
36+
* `items[].image` renamed `image[].name`
37+
* `items[].registry_id` renamed `image[].regopts_id`
38+
* `watch.os` and `watch.arch` moved to `image[].os` and `image[].arch`
39+
40+
> **0.x**
41+
```yaml
42+
watch:
43+
os: linux
44+
arch: amd64
45+
46+
registries:
47+
someregistryoptions:
48+
username: foo
49+
password: bar
50+
timeout: 20
51+
52+
items:
53+
- image: docker.io/crazymax/nextcloud:latest
54+
registry_id: someregistryoptions
55+
```
56+
57+
> **1.x**
58+
```yaml
59+
regopts:
60+
someregistryoptions:
61+
username: foo
62+
password: bar
63+
timeout: 20
64+
65+
image:
66+
- name: docker.io/crazymax/nextcloud:latest
67+
regopts_id: someregistryoptions
68+
os: linux
69+
arch: amd64
70+
```

0 commit comments

Comments
 (0)