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 df1f8e3 commit 00c385b
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 5 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ It can be used as a GitHub action or as a standalone script/integrated into othe
* can be used as a GitHub action
* can be used as a standalone script.

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

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

```

Expand All @@ -47,7 +53,7 @@ jobs:

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

- name: create pull-request
uses: peter-evans/create-pull-request@v5
Expand Down
4 changes: 2 additions & 2 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ name: 'Drupal Composer updates'
description: 'Used to perform updates of Drupal core and/or contributed modules'
author: 'valicm'
branding:
icon: activity
color: white
icon: check-circle
color: blue
inputs:
update_type:
description: 'Are we doing minor or major updates. Allowed values are semver-safe-update or all'
Expand Down
2 changes: 1 addition & 1 deletion examples/drupal-automated-update.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:

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

- name: create pull-request
uses: peter-evans/create-pull-request@v5
Expand Down

0 comments on commit 00c385b

Please sign in to comment.