Skip to content

Include completed successful runs when deduplicating #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Include completed successful runs when deduplicating #4

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7390a5a
fix: the action always runs as the latest commit, so it will not find…
m0n5t3r Feb 23, 2021
acd4af7
Merge branch 'master' of https://github.com/ahmadnassri/action-workfl…
m0n5t3r Feb 23, 2021
59c0ee6
fix: include completed successful runs when deduplicating
m0n5t3r Feb 23, 2021
84ae5e6
fix: apparently this check is pointless
m0n5t3r Feb 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions action/lib/deduplicate.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ export default async function ({ octokit, workflow_id, run_id }) {

// filter and sort
const cancellable = workflow_runs
// filter to relevant runs
.filter(run => ['in_progress', 'queued'].includes(run.status))
// filter to only runs for the same commit
.filter(run => run.head_sha === sha)
// filter out unsuccessful completed runs (cancelled / failed)
.filter(run => (run.status !== 'completed') || (run.conclusion === 'success'))
// pick relevant properties
.map(run => ({ id: run.id, name: run.name, created_at: run.created_at }))
// sort
Expand All @@ -46,6 +46,8 @@ export default async function ({ octokit, workflow_id, run_id }) {
core.debug(inspect(prime))

for (const run of cancellable) {
if (run.status === 'completed') continue
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose this would work ...

but, wouldn't it better to first check if there is a completed run FIRST (before getting this deep) and if one is already completed, exit early?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I went for the least amount of logic changes that would do the trick, my test version looked like this (sort and map no longer needed, just filter the runs and if the list is not empty just cancel the current workflow - it proved very reliable in my case, but I didn't want to force my luck :) ):

    // filter
    const current_runs = workflow_runs
      // exclude this one
      .filter(run => run.id !== run_id)
      // filter to only runs for the same commit
      .filter(run => run.head_sha === sha)
      // filter out unsuccessful completed runs (cancelled / failed)
      .filter(run => (run.status !== 'completed') || (run.conclusion === 'success'))
  
    core.info(`found ${current_runs.length} existing runs of workflow ${workflow_id} for sha ${sha}`)
  
    if(current_runs.length > 0) {
      core.info('successful or in-progress runs found, bailing out')
      await octokit.request('POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel', {
        ...github.context.repo,
        run_id: run_id
      })
    }


core.info(`${run.name}#${run.id} => canceling`)

await octokit.request('POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel', {
Expand Down