Consistent usage of term 'workflow run' (#266)

Author: paescuj

README.md

@@ -2,35 +2,35 @@
 
 `skip-duplicate-actions` provides the following features to optimize GitHub Actions:
 
-- [Skip duplicate workflow-runs](#skip-duplicate-workflow-runs) after merges, pull requests or similar.
-- [Skip concurrent or parallel workflow-runs](#skip-concurrent-workflow-runs) for things that you do not want to run twice.
+- [Skip duplicate workflow runs](#skip-duplicate-workflow-runs) after merges, pull requests or similar.
+- [Skip concurrent or parallel workflow runs](#skip-concurrent-workflow-runs) for things that you do not want to run twice.
 - [Skip ignored paths](#skip-ignored-paths) to speedup documentation-changes or similar.
 - [Skip if paths not changed](#skip-if-paths-not-changed) for something like directory-specific tests.
-- [Cancel outdated workflow-runs](#cancel-outdated-workflow-runs) after branch-pushes.
+- [Cancel outdated workflow runs](#cancel-outdated-workflow-runs) after branch-pushes.
 
 All of those features help to save time and costs; especially for long-running workflows.
 You can choose any subset of those features.
 
-## Skip duplicate workflow-runs
+## Skip duplicate workflow runs
 
-If you work with feature branches, then you might see lots of _duplicate workflow-runs_.
-For example, duplicate workflow-runs can happen if a workflow runs on a feature branch, but then the workflow is repeated right after merging the feature branch.
+If you work with feature branches, then you might see lots of _duplicate workflow runs_.
+For example, duplicate workflow runs can happen if a workflow run is performed on a feature branch, but then the workflow run is repeated right after merging the feature branch.
 `skip-duplicate-actions` allows to prevent such runs.
 
 - **Full traceability:** After clean merges, you will see a message like `Skip execution because the exact same files have been successfully checked in <previous_run_URL>`.
 - **Fully configurable:** By default, manual triggers and cron will never be skipped.
 - **Flexible Git usage:** `skip-duplicate-actions` does not care whether you use fast-forward-merges, rebase-merges or squash-merges.
-  However, if a merge yields a result that is different from the source branch, then the resulting workflow-run will _not_ be skipped.
+  However, if a merge yields a result that is different from the source branch, then the resulting workflow run will _not_ be skipped.
   This is commonly the case if you merge "outdated branches".
 
-## Skip concurrent workflow-runs
+## Skip concurrent workflow runs
 
 Sometimes, there are workflows that you do not want to run twice at the same time even if they are triggered twice.
-Therefore, `skip-duplicate-actions` provides the following options to skip a workflow-run if the same workflow is already running:
+Therefore, `skip-duplicate-actions` provides the following options to skip a workflow run if the same workflow is already running:
 
 - **Always skip:** This is useful if you have a workflow that you never want to run twice at the same time.
 - **Only skip same content:** For example, this can be useful if a workflow has both a `push` and a `pull_request` trigger, or if you push a tag right after pushing a commit.
-  (*Deprecated*, use `same_content_newer` instead)
+  (_Deprecated_, use `same_content_newer` instead)
 - **Only skip newer runs with the same content:** If the same workflow is running on the exact same content, skip newer runs of it. `same_content_newer` ensures that at least one of those workflows will run, while `same_content` may skip all of them.
 - **Only skip outdated runs:** For example, this can be useful for skip-checks that are not at the beginning of a job.
 - **Never skip:** This disables the concurrent skipping functionality, but still lets you use all other options like duplicate skipping.
@@ -64,12 +64,12 @@ Instead of blindly skipping checks, the backtracking-algorithm will only skip so
 
 You can use the [`paths_filter`](#paths_filter) option if you need to define multiple `paths` patterns in a single workflow.
 
-## Cancel outdated workflow-runs
+## 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` can be configured to 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 <previous_run_URL>`.
+- **Full traceability:** If a workflow run is cancelled, then you will see a message like `Cancelled <previous_run_URL>`.
 - **Guaranteed execution:** The cancellation-algorithm guarantees that a complete check-set will finish no matter what.
 
 ## Inputs
@@ -121,7 +121,7 @@ See the corresponding [`paths_result`](#paths_result) output and [example config
 
 ### `cancel_others`
 
-If true, then workflow-runs from outdated commits will be cancelled.
+If true, then workflow runs from outdated commits will be cancelled.
 
 **Default:** `'false'`
 
@@ -141,7 +141,7 @@ Possible values are `pull_request`, `push`, `workflow_dispatch`, `schedule`.
 
 ### `concurrent_skipping`
 
-Skip a workflow-run if the same workflow is already running.
+Skip a workflow run if the same workflow is already running.
 
 One of `never`, `same_content`, `same_content_newer`, `outdated_runs`, `always`.
 
@@ -334,12 +334,12 @@ jobs:
 
 ## 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.
-`skip-duplicate-actions` will only look at workflow-runs that belong to the same workflow as the current workflow-run.
-After querying such workflow-runs, it will compare them with the current workflow-run as follows:
+`skip-duplicate-actions` uses the [Workflow Runs API](https://docs.github.com/en/rest/reference/actions#workflow-runs) to query workflow runs.
+`skip-duplicate-actions` will only look at workflow runs that belong to the same workflow as the current workflow run.
+After querying such workflow runs, it will compare them with the current workflow run as follows:
 
-- If there exists a workflow-runs with the same tree hash, then we have identified a duplicate workflow-run.
-- If there exists an in-progress workflow-run, then we can cancel it or skip, depending on your configuration.
+- If there exists a workflow run with the same tree hash, then we have identified a duplicate workflow run.
+- If there exists an in-progress workflow run, then we can cancel it or skip, depending on your configuration.
 
 ## How does path-skipping work?
 

action.yml

@@ -1,5 +1,5 @@
 name: 'Skip Duplicate Actions'
-description: 'Skip duplicate workflow-runs. Skip or ignore specific paths. Cancel outdated workflow-runs.'
+description: 'Skip duplicate workflow runs. Skip or ignore specific paths. Cancel outdated workflow runs.'
 author: 'fkirc'
 branding:
   icon: 'stop-circle'
@@ -21,7 +21,7 @@ inputs:
     description: 'A YAML-string with named paths_ignore/paths patterns'
     required: false
   cancel_others:
-    description: 'If true, then workflow-runs from outdated commits will be cancelled'
+    description: 'If true, then workflow runs from outdated commits will be cancelled'
     required: false
     default: 'false'
   skip_after_successful_duplicate:

dist/index.js

@@ -91,7 +91,7 @@ function parseWorkflowRun(run: ActionsGetWorkflowRunResponseData): WorkflowRun {
   }
   const workflowId = run.workflow_id
   if (!workflowId) {
-    logFatal(`Could not find the workflow id of run ${run.id}`)
+    logFatal(`Could not find the workflow ID of run ${run.id}`)
   }
   return {
     event: run.event as WRunTrigger,
@@ -122,7 +122,7 @@ function parseOlderRuns(
   currentRun: WorkflowRun
 ): WorkflowRun[] {
   const olderRuns = response.workflow_runs.filter(run => {
-    // Only consider older workflow-runs to prevent some nasty race conditions and edge cases.
+    // Only consider older workflow runs to prevent some nasty race conditions and edge cases.
     return (
       new Date(run.created_at).getTime() <
       new Date(currentRun.createdAt).getTime()
@@ -214,7 +214,7 @@ async function main(): Promise<void> {
       const successfulDuplicateRun = detectSuccessfulDuplicateRuns(context)
       if (successfulDuplicateRun) {
         core.info(
-          `Skip execution because the exact same files have been successfully checked in ${successfulDuplicateRun.html_url}`
+          `Skip execution because the exact same files have been successfully checked in run ${successfulDuplicateRun.html_url}`
         )
         exitSuccess({
           shouldSkip: true,
@@ -278,7 +278,7 @@ async function cancelOutdatedRuns(context: WRunContext): Promise<void> {
     )
   })
   if (!cancelVictims.length) {
-    return core.info('Did not find other workflow-runs to be cancelled')
+    return core.info('Did not find other workflow runs to be cancelled')
   }
   for (const victim of cancelVictims) {
     await cancelWorkflowRun(victim, context)
@@ -295,7 +295,7 @@ async function cancelWorkflowRun(
       repo: context.repoName,
       run_id: run.runId
     })
-    core.info(`Cancelled ${run.html_url} with response code ${res.status}`)
+    core.info(`Cancelled run ${run.html_url} with response code ${res.status}`)
   } catch (e) {
     if (e instanceof Error || typeof e === 'string') {
       core.warning(e)
@@ -328,7 +328,7 @@ function detectConcurrentRuns(context: WRunContext): WorkflowRun | undefined {
   })
 
   if (!concurrentRuns.length) {
-    core.info(`Did not find any concurrent workflow-runs`)
+    core.info(`Did not find any concurrent workflow runs`)
     return
   }
   if (context.concurrentSkipping === 'always') {
@@ -354,7 +354,7 @@ function detectConcurrentRuns(context: WRunContext): WorkflowRun | undefined {
     )
     if (concurrentDuplicate) {
       core.info(
-        `Skip execution because the exact same files are concurrently checked in ${concurrentDuplicate.html_url}`
+        `Skip execution because the exact same files are concurrently checked in run ${concurrentDuplicate.html_url}`
       )
       return concurrentDuplicate
     }
@@ -366,12 +366,12 @@ function detectConcurrentRuns(context: WRunContext): WorkflowRun | undefined {
     )
     if (concurrentIsOlder) {
       core.info(
-        `Skip execution because the exact same files are concurrently checked in older ${concurrentIsOlder.html_url}`
+        `Skip execution because the exact same files are concurrently checked in older run ${concurrentIsOlder.html_url}`
       )
       return concurrentIsOlder
     }
   }
-  core.info(`Did not find any concurrent workflow-runs that justify skipping`)
+  core.info(`Did not find any concurrent workflow runs that justify skipping`)
 }
 
 async function backtracePathSkipping(
@@ -475,7 +475,7 @@ async function backtracePathSkipping(
     // Should be never reached in practice; we expect that this loop aborts after 1-3 iterations.
     if (distanceToHEAD++ >= 50) {
       core.warning(
-        'Aborted commit-backtracing due to bad performance - Did you push an excessive number of ignored-path-commits?'
+        'Aborted commit-backtracing due to bad performance - Did you push an excessive number of ignored-path commits?'
       )
       break
     }