Prepare major bump (#40)

* Fixes readme and adds deprecation notices/upcoming BCs
* Updates vulnerable dependencies
* Reformats action definition file

README.md

@@ -15,6 +15,9 @@ filter can be applied to deleted workflow runs by status/conclusion - see input
 | `remove-older-than` | Remove workflows older than timeframe | `<null>`              | `true`      |
 | `remove-skipped`    | Remove skipped workflows              | `false`               | `true`      |
 
+> [!WARNING]
+> In the next major version the default of `remove-obsolete` will change from `true` to `false`!
+
 ### Remarks on the input fields
 All inputs are optional - if any input is not given, the default value will be used.
 
@@ -55,7 +58,7 @@ All inputs are optional - if any input is not given, the default value will be u
 `remove-older-than`</dt>
 <dd>
 
-- Remove workflows from the list that are older than the given timeframe (e.g. '10S', '30M', '12H', '7d', '2w', '1m', '6y')
+- Remove workflows from the list that are older than the given timeframe (e.g. '10s', '30m', '12h', '7d', '2w', '6y' or any combination of these).
 - Accepts a (multiline) `string` in the format of `NU [W]` where `N` is a number, `U` is a time unit and optionally `W` is the workflow name.
   The following units are supported:
   - `s` for seconds
@@ -129,7 +132,7 @@ jobs:
 
 The following example will remove all workflow runs that are older than 4 weeks and all runs of the current workflow older than 1 day:
 ```yaml
-name: Weekly purge of workflow runs older than a week
+name: Weekly purge of any workflow runs older than four weeks and current workflow runs older than one day
 on:
   schedule:
     - cron: '0 0 * * 0'

action.yml

@@ -1,7 +1,7 @@
 name: Purge deprecated workflow runs
 description: >-
-  Delete GH workflow runs that don't have a definition (anymore).
-  Optionally delete cancelled, failed, outdated or skipped runs.
+  Delete GH workflow runs that don't have a definition (anymore). Optionally
+  delete cancelled, failed, outdated or skipped runs.
 author: hanseartic
 inputs:
   token: