command-output-file-action's Introduction

command-output-file-action

Github Action to generate an output file from a command execution (success or error) 📝

📚 How to use this action?

The actions/checkout is mandatory to use this action, as it will be necessary to access the repository files to get the output file after the action execution.

Field	Mandatory	Observation
command_line	YES	ex: `ls -lha`
output_file_name	YES	ex: `output.txt`
display_file_content	NO	`YES` (default) or `NO`

⚠️ NOTES:

A command line error won't break the workflow, but just extract the output on the file.
You can then access the output file in the directory where you ran the action.

📝 Usage example

WITH output file display on workflow run

    steps:
      - uses: actions/[email protected]
      - uses: GuillaumeFalourd/[email protected]
        with:
          command_line: ls -lha
          output_file_name: output.txt
          display_file_content: YES # this is also the default value if not informed

WITHOUT output file display on workflow run

    steps:
      - uses: actions/[email protected]
      - uses: GuillaumeFalourd/[email protected]
        with:
          command_line: ls -lha
          output_file_name: output.txt
          display_file_content: NO # YES is the default value if not informed