action-composite.yaml

# this is an example metadata file for a GitHub Composite Action
# the file must be named 'action.yaml' or 'action.yml'
# source: https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions
# source: https://docs.github.com/en/actions/creating-actions/creating-a-composite-action

name: 'Hello World' # name of your Composite Action. required
author: 'Nathan Nellans' # author of your Composite Action. optional
description: 'Greet someone' # description of your Composite Action. required
branding: # branding is shown next to your action name in GitHub Marketplace. optional
  color: 'green' # options are: white, yellow, blue, green, orange, red, purple, gray-dark
  icon: 'globe' # pick an option from https://feathericons.com, however some options are omitted, read the docs

inputs: # specifies input parameters that your Composite Action expects to receive when being called
  who-to-greet: # id of this input parameter. required. must start with a letter or underscore. can only contain letters, numbers, dashes, or underscores. recommend using lowercase input ids
    description: 'Who to greet' # description of this input parameter. required
    required: true # specifies if your Composite Action requires a value for this input parameter. optional
    default: 'World' # default value to use if a value is not supplied when called. optional
    deprecationMessage: 'Some Warning Message' # use this to warn users that the input is deprecated. optional

runs:
  using: 'composite' # must be set to composite
  steps: # the steps that you plan to run in this Composite Action

    - id: # id of the step, so you can reference this step later. optional
      name: # name of the step. optional
      if: # step conditions, ${{ ... }} can optionally be used to enclose your condition. optional
      env: # step-level variables. optional
        KEY: value
        KEY: value
      working-directory: # only for 'run' steps, sets the current working directory. optional
      run: echo Hello ${{ inputs.who-to-greet }}. # single-line command to run
      shell: bash # required for a 'run' step. options are: bash, pwsh, python, sh, cmd, powershell

    - id: random-number-generator
      run: echo "random-number=$(echo $RANDOM)" >> $GITHUB_OUTPUT
      shell: bash

    - run: echo "${{ github.action_path }}" >> $GITHUB_PATH
      shell: bash

    - run: goodbye.sh
      shell: bash

    - uses: actions/hello_world@main # run a GitHub Action step
      with: # parameters to pass to the action, must match what is defined in the action
        key: value
        key: value

outputs:
  random-number: # id of this output parameter. required. must start with a letter or underscore. can only contain letters, numbers, dashes, or underscores
    description: 'Random number' # description of this output parameter. required
    value: ${{ steps.random-number-generator.outputs.random-number }} # value of this output parameter. required. can be set to a string or an expression