Support labeled events

[lumi017]

I would like pr-preview to run only if a specific label is added to a PR. However listening to labeled events, causes pr-preview to skip executing

on:
  workflow_dispatch:
  pull_request:
    branches: [main]
    types:
      - opened
      - reopened
      - synchronize
      - closed
      - labeled

together with

      - name: Create Preview
        if: contains(github.event.pull_request.labels.*.name, 'pr-preview')
        uses: rossjrw/pr-preview-action@v1

Adding a label to the PR results in:

Determining auto action
event_name is pull_request; proceeding
event_type is labeled
unknown event type labeled; no action to take

[rossjrw]

Moved from issues to discussion as this is about debugging a setup rather than a feature request.

See the documentation on the action parameter in the readme:

auto (default) - determine whether to deploy or remove the preview based on the emitted event. If the event is pull_request, it will deploy the preview when the event type is opened, reopened and synchronize, and remove it on closed events. Does not do anything for other events or event types, even if you explicitly instruct the workflow to run on them.

You need to set the action parameter in your workflow based on the label information. Simplest version:

- name: Create Preview
  uses: rossjrw/pr-preview-action@v1
  if: contains(github.event.pull_request.labels.*.name, 'pr-preview')
  with:
    action: ${{ github.event.action == "closed" && 'remove' || 'deploy' }}

Or, you might want to remove the preview if the label is removed:

- name: Create Preview
  uses: rossjrw/pr-preview-action@v1
  with:
    action: >-
      ${{
        github.event_name == "pull_request"
        && github.event.action != "closed"
        && contains(github.event.pull_request.labels.*.name, 'pr-preview')
        && 'deploy' || 'remove'
      }}

Should the action run on labeled events anyway? I don't think so - labelling is generally a no-op action, I wouldn't generally expect adding/removing a label to do anything, outside of specific configurations like yours. Even then, there's no way for this action to know ahead of time specifically which label to look for, or any custom behaviour you need.

[lumi017]

Ok, I see it's expected behavior because of the action: auto. Removed it and separated in two steps to always run the cleanup when PR is closed:

      - name: Create Preview
        uses: rossjrw/pr-preview-action@v1
        if: contains(github.event.pull_request.labels.*.name, 'pr-preview') && github.event.action != 'closed'
        with:
          action: deploy

and

      - name: Remove Preview
        uses: rossjrw/pr-preview-action@v1
        if: github.event.action == 'closed'
        with:
          action: remove