Don't run actions on draft pull requests

Code to Cloud GitHub Actions
#1

I am trying to set up my workflow so it doesn’t run when opening/synching/reopening pull requests that are marked as draft.

I have found that I can use

if: github.event.pull_request.draft == false

on my job, but it will still run for a few seconds, and “fail”, leaving a red X on every commit on the PR until it is marked ready for reveiw.

I could maybe add a dummy-job that has

if: github.event.pull_request.draft == true

on it, and just echo something, but it will still run for a few seconds though.

My test-workfow so far looks like this:

name: Deploy test

on:
  pull_request:
    branches: [master]
    types: [synchronize, opened, reopened, ready_for_review]

jobs:
  build:
    runs-on: ubuntu-latest
    if: github.event.pull_request.draft == false
    timeout-minutes: 10

    steps:
    - uses: actions/checkout@v1
    - name: Run all the stuff to set up my site and run tests
      run: set_up_site

  draft-build:
    runs-on: ubuntu-latest
    if: github.event.pull_request.draft == true
    timeout-minutes: 1

    steps:
    - name: Run a one-line script
      run: echo Draft PR, you are good.

Will those seconds be added up and billed? Is there another or better way of getting around this?

3 Likes
How to run on all pushes except to draft PRs?
#2

jobs.<id>.if is broken currently, that’s why you get “fail” instead of “skip” status.

1 Like
#3

Ah, okay. So if I just leave it as-is and they fix the issue it won’t be a problem?

#4

Yeah, if you don’t mind extra notifications. I’m not touching mine waiting for a fix - beauty of betas :]

1 Like
#5

I can confirm that this works for me now:

if: github.event.pull_request.draft == false

Thanks for pointing it out!

1 Like
#6

Because of this, I have found a better way for myself.

on:
  pull_request:
    types: [review_requested, ready_for_review]

See
https://help.github.com/en/actions/reference/events-that-trigger-workflows#pull-request-event-pull_request
https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#onevent_nametypes

1 Like
#7

@viktorianer 

on:
  pull_request:
    types: [review_requested, ready_for_review]

This isn’t working for me. Github actions are run anyways.

#8

@wipe2238 

if: github.event.pull_request.draft == false

Is working but it has 2 drawbacks:

 - The check is reported as successful even though it didn’t actually run

 - When the PR is switched from “draft” to “ready” the CI does not run again and the check is still marked as successful so  a user is able to merge the PR without having the check actually pass. 

#9

@julioromano
Could you provide your configuration? Because, it should work. We use it in our configuration and it is working very well.

#10

@viktorianer 

name: My CI

on:
  push:
    branches: [master]
    tags:
      - '*'
  pull_request:
    types: [review_requested, ready_for_review]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
        # omitted
#11

@julioromano
Thank you.

But I do not see my suggested solution in your configuration :roll_eyes:.

#12

Sorry brainfart :slight_smile: I edited it.

I pasted wrong code while trying other solutions.

#13

@julioromano I think it is not working because you have these two lines here, which is not what I suggested. 

@julioromano wrote:

@viktorianer 

 

name: My CI

on:
push:
branches: [master]
…

 

You should remove them. 

It should look like this:

name: reviewdog
on:
  pull_request:
    types: [review_requested, ready_for_review]
jobs:
  ...:
#14

I tested it, still not very practical : it would run action once after undrafting or review request, but not for further pushes on the PR (e.g. when the reviewer asked changes and the developer pushes them).

When your actions are running tests or lint… it’s not ideal.

#15

Just invite the reviewer again (small refresh button next to the name). It is not really good, but works. Unlike other things.

#16

It seems to me that you should just use both:

on:  
  pull_request:
    types: [opened, synchronize, reopened, ready_for_review]
jobs:
  JOB:
    if: github.event.pull_request.draft == false

So it won’t run while draft, but it does run when undrafting and for future updates.

5 Likes
#17

@natario1’s solution works very well! Thanks!

I have one issue though: When I press “Ready for review”, it takes a couple of seconds for the new run to trigger. During that time the check is marked as passed. It’s enough time to easily merge the pull request. This makes it possible to accidentally bypass the branch protection rule that the check must pass before merging. :scream:

1 Like
#18

This would be a simpler solution

on:  
  pull_request:

jobs:
  JOB:
    if: github.event.pull_request.draft == false
#19

@chenrui333 nope, your simpler version won’t work, see the official notes:

Note: By default, a workflow only runs when a pull_request 's activity type is opened , synchronize , or reopened . To trigger workflows for more activity types, use the types keyword.