Skip to content

Commit 00c385b

Browse files
committed
Update readme
1 parent df1f8e3 commit 00c385b

File tree

3 files changed

+11
-5
lines changed

3 files changed

+11
-5
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ It can be used as a GitHub action or as a standalone script/integrated into othe
1010
* can be used as a GitHub action
1111
* can be used as a standalone script.
1212

13+
## Notes
14+
* supported update type modes are `semver-safe-update` and `all`. `All` represents full upgrade between major core versions.
15+
* Semver necessarily does not mean minor versions only (etc 2.1.0, 2.1.2).
16+
* If you requested package as `^11.0`, any release as `^11.5` is considered by this script as `minor`.
17+
* The provided patch failures could be in some scenarios false-positive.
18+
* This tool is not providing a one click upgrade - review release notes for each module, etc.
1319

1420
## GitHub Action Usage
1521
![](https://vallic.com/sites/default/files/2023-11/github_example.png "GitHub Drupal Upgrades")
@@ -21,7 +27,7 @@ See [action.yml](action.yml)
2127
- uses: actions/checkout@v2
2228
- name: Check updates
2329
id: updates
24-
uses: valicm/drupal-update@v3
30+
uses: valicm/drupal-update@v4
2531

2632
```
2733

@@ -47,7 +53,7 @@ jobs:
4753

4854
- name: Check updates
4955
id: updates
50-
uses: valicm/drupal-update@v3
56+
uses: valicm/drupal-update@v4
5157

5258
- name: create pull-request
5359
uses: peter-evans/create-pull-request@v5

action.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ name: 'Drupal Composer updates'
22
description: 'Used to perform updates of Drupal core and/or contributed modules'
33
author: 'valicm'
44
branding:
5-
icon: activity
6-
color: white
5+
icon: check-circle
6+
color: blue
77
inputs:
88
update_type:
99
description: 'Are we doing minor or major updates. Allowed values are semver-safe-update or all'

examples/drupal-automated-update.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ jobs:
1313

1414
- name: Check updates
1515
id: updates
16-
uses: valicm/drupal-update@v3
16+
uses: valicm/drupal-update@v4
1717

1818
- name: create pull-request
1919
uses: peter-evans/create-pull-request@v5

0 commit comments

Comments
 (0)