https://github.com/andstor/file-reader-action

:page_facing_up: :octocat: GitHub Action to read the contents of a file
https://github.com/andstor/file-reader-action

Last synced: 1 day ago
JSON representation

:page_facing_up: :octocat: GitHub Action to read the contents of a file

• Host: GitHub
• URL: https://github.com/andstor/file-reader-action
• Owner: andstor
• License: mit
• Created: 2020-04-27T14:19:58.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-06-07T15:17:24.000Z (5 months ago)
• Last Synced: 2024-11-04T14:45:58.321Z (10 days ago)
• Language: TypeScript
• Homepage: https://github.com/marketplace/actions/file-reader
• Size: 350 KB
• Stars: 14
• Watchers: 3
• Forks: 6
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# file-reader-ation

> GitHub Action to read the contents of a file

![build-test](https://github.com/andstor/file-reader-action/workflows/build/badge.svg)

This is a GitHub Action to read the contents of a file. Give it a path to a file and it provides you with the file's contents, accessible through an output variable.

## Usage

The following example [workflow step](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow) will read the contents of the `package.json` file.

```yml

- name: "Read file contents"

  uses: andstor/file-reader-action@v1

  with:

    path: "package.json"

```

## Options ⚙️

The following input variables 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.

## Example

```yml

name: "Read file contents"

on: [push, pull_request]

jobs:

  file_contents:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout code

        uses: actions/checkout@v1

      - name: Read file contents

        id: read_file

        uses: andstor/file-reader-action@v1

        with:

          path: "package.json"

      - name: File contents

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

```

## License

Copyright © 2020 [André Storhaug](https://github.com/andstor)

file-reader-action is licensed under the [MIT License](https://github.com/andstor/file-reader-ation/blob/master/LICENSE).