Skip to content

Commit 71ad3dc

Browse files
committed
Update readme
1 parent 1513be0 commit 71ad3dc

File tree

2 files changed

+32
-3
lines changed

2 files changed

+32
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22
Bash script for updating Drupal core and/or contributed modules with Composer.
33
It can be used as a GitHub action or as a standalone script/integrated into other CI tools.
44

5-
![](https://vallic.com/sites/default/files/2023-11/github_pr.png "GitHub Drupal Upgrades")
6-
75
## Features
86
* perform minor or major updates to Drupal core / contributed modules
97
* options to exclude modules from check and/or enable Drupal core checks
108
* outputs Markdown table of changes as a file or environment variable
9+
* highlight failed patches
1110
* can be used as a GitHub action
1211
* can be used as a standalone script.
1312

1413

1514
## GitHub Action Usage
15+
![](https://vallic.com/sites/default/files/2023-11/github_example.png "GitHub Drupal Upgrades")
1616

1717
See [action.yml](action.yml)
1818

@@ -47,7 +47,7 @@ jobs:
4747

4848
- name: Check updates
4949
id: updates
50-
uses: valicm/drupal-update@v2
50+
uses: valicm/drupal-update@v3
5151

5252
- name: create pull-request
5353
uses: peter-evans/create-pull-request@v5
@@ -62,6 +62,8 @@ jobs:
6262
```
6363

6464
## Standalone script usage
65+
![](https://vallic.com/sites/default/files/2023-11/local_example.png "GitHub Drupal Upgrades")
66+
6567
| Example | Command |
6668
|-----------------------------------------------|----------------------------------------------|
6769
| Run all minor and security updates | `bash drupal-update.sh` |

examples/drupal-automated-update.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Automated Drupal updates
2+
3+
on:
4+
workflow_dispatch:
5+
schedule:
6+
- cron: '0 0 * * *'
7+
8+
jobs:
9+
check-available-updates:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v2
13+
14+
- name: Check updates
15+
id: updates
16+
uses: valicm/drupal-update@v3
17+
18+
- name: create pull-request
19+
uses: peter-evans/create-pull-request@v5
20+
with:
21+
# Create personal token, and add that value under GitHub repository as MY_PERSONAL_TOKEN
22+
token: ${{ secrets.MY_PERSONAL_TOKEN }}
23+
commit-message: Automated Drupal updates
24+
title: Automated Drupal updates
25+
body: ${{ env.DRUPAL_UPDATES_TABLE }}
26+
branch: drupal-automated-updates
27+
delete-branch: true

0 commit comments

Comments
 (0)