Why are required inputs to GitHub Actions not enforced?

user_6877667 0
Viewed 598

I'm writing a JavaScript action for GitHub Actions that has inputs, some of which are required. A simple example:

name: 'My action'
description: 'My description'
author: 'me'
inputs:
  thisOneIsOptional: 
    description: 'An optional input'
    required: false
  thisOneIsRequired: 
    description: 'A required input'
    required: true
runs:
  using: 'node12'
  main: '../lib/main.js'

What I find surprising is that I can use this action in a workflow without providing the required parameter and GitHub does not complain. It seems as though it is up to the action itself to validate that the required inputs were in fact provided. Is that right?

Is there anyway to get GitHub to validate this for me before my action code gets called?

github-actions
1 Answers

Currently GitHub does not check if required input has been passed. This is being tracked in this issue.

However, you can implement validation yourself using bash, e.g.

- run: |
    [[ "${{ inputs.docker_image_name }}" ]] || { echo "docker_image_name input is empty" ; exit 1; }
    [[ "${{ inputs.doppler_token }}" ]] || { echo "doppler_token input is empty" ; exit 1; }
  shell: bash
user_3686910
Related