Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
valicm committed Nov 1, 2023
1 parent 1513be0 commit 71ad3dc
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@
Bash script for updating Drupal core and/or contributed modules with Composer.
It can be used as a GitHub action or as a standalone script/integrated into other CI tools.

![](https://vallic.com/sites/default/files/2023-11/github_pr.png "GitHub Drupal Upgrades")

## Features
* perform minor or major updates to Drupal core / contributed modules
* options to exclude modules from check and/or enable Drupal core checks
* outputs Markdown table of changes as a file or environment variable
* highlight failed patches
* can be used as a GitHub action
* can be used as a standalone script.


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

See [action.yml](action.yml)

Expand Down Expand Up @@ -47,7 +47,7 @@ jobs:

- name: Check updates
id: updates
uses: valicm/drupal-update@v2
uses: valicm/drupal-update@v3

- name: create pull-request
uses: peter-evans/create-pull-request@v5
Expand All @@ -62,6 +62,8 @@ jobs:
```

## Standalone script usage
![](https://vallic.com/sites/default/files/2023-11/local_example.png "GitHub Drupal Upgrades")

| Example | Command |
|-----------------------------------------------|----------------------------------------------|
| Run all minor and security updates | `bash drupal-update.sh` |
Expand Down
27 changes: 27 additions & 0 deletions examples/drupal-automated-update.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Automated Drupal updates

on:
workflow_dispatch:
schedule:
- cron: '0 0 * * *'

jobs:
check-available-updates:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2

- name: Check updates
id: updates
uses: valicm/drupal-update@v3

- name: create pull-request
uses: peter-evans/create-pull-request@v5
with:
# Create personal token, and add that value under GitHub repository as MY_PERSONAL_TOKEN
token: ${{ secrets.MY_PERSONAL_TOKEN }}
commit-message: Automated Drupal updates
title: Automated Drupal updates
body: ${{ env.DRUPAL_UPDATES_TABLE }}
branch: drupal-automated-updates
delete-branch: true

0 comments on commit 71ad3dc

Please sign in to comment.