GitHub File Reader Action V2

GitHub Action to read the contents of a file

Important

Disclaimer: This version was created because the creator has not updated the original (V1) for a while.

This is a GitHub Action that reads a file's contents. If you give it a path to a file, it will provide its contents and file size, accessible through an output variable.

Usage

The following example workflow step will read the contents of the package.json file.

- name: 'Read file contents'
  uses: guibranco/github-file-reader-action-v2@latest
  id: read_file
  with:
    path: 'package.json'

Options ⚙️

The following input variable options can/must be configured:

Input variable	Necessity	Description	Default
path	Required	the path to the file to read.
encoding	Optional	the encoding of the file to read.	utf8

Outputs

• contents: The contents of the file.
• size: The size of the file.

Example

name: 'Read file contents'

on: [push, pull_request]

jobs:
  file_contents:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Read file contents
        uses: guibranco/github-file-reader-action-v2@latest
        id: read_file
        with:
          path: 'package.json'

      - name: File contents
        run: echo "${ steps.read_file.outputs.contents }"

      - name: File size
        run: echo "${ steps.read_file.outputs.size }"

License

Copyright © 2024 André Storhaug, GuiBranco.

file-reader-action-v2 is licensed under the MIT License.