From 7ab7fea26f92d517d99f07d523cb5cce19fbf8a7 Mon Sep 17 00:00:00 2001 From: Felix Kirchengast <17876666+fkirc@users.noreply.github.com> Date: Thu, 18 Mar 2021 14:13:08 +0100 Subject: [PATCH] Update cancellation-docs --- README.md | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/README.md b/README.md index 96959af..ef5e43f 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ Instead of blindly skipping checks, the backtracking-algorithm will only skip so ## Cancel outdated workflow-runs Typically, workflows should only run for the most recent commit. -Therefore, when you push changes to a branch, `skip-duplicate-actions` will cancel any previous workflow-runs that run against outdated commits. +Therefore, when you push changes to a branch, `skip-duplicate-actions` can be configured to cancel any previous workflow-runs that run against outdated commits. - **Full traceability:** If a workflow-run is cancelled, then you will see a message like `Cancelled `. - **Guaranteed execution:** The cancellation-algorithm guarantees that a complete check-set will finish no matter what. @@ -161,15 +161,6 @@ jobs: echo "Do other stuff..." ``` -### Option 3: Cancellation-only - -If you do not care about the skip-features, then you can simply ignore the `should_skip`-output. -In this case, the integration reduces to the following: - -```yml - - uses: fkirc/skip-duplicate-actions@master -``` - ## How does it work? `skip-duplicate-actions` uses the [Workflow Runs API](https://docs.github.com/en/rest/reference/actions#workflow-runs) to query workflow-runs.