https://github.com/igorskyflyer/action-readfile

🌬️ A GitHub Action to read an arbitrary file and either output it or use it in another GitHub Action. 🍃
https://github.com/igorskyflyer/action-readfile

action back-end blob buffer filesystem fs github igorskyflyer javascript js read-file readfile text utility

Last synced: 3 days ago
JSON representation

🌬️ A GitHub Action to read an arbitrary file and either output it or use it in another GitHub Action. 🍃

• Host: GitHub
• URL: https://github.com/igorskyflyer/action-readfile
• Owner: igorskyflyer
• License: mit
• Created: 2024-06-20T20:11:05.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-06-21T00:06:41.000Z (3 months ago)
• Last Synced: 2024-09-20T15:25:58.885Z (7 days ago)
• Topics: action, back-end, blob, buffer, filesystem, fs, github, igorskyflyer, javascript, js, read-file, readfile, text, utility
• Language: JavaScript
• Homepage: https://github.com/marketplace/actions/read-local-file
• Size: 242 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# readfile()

🌬️ A GitHub Action to read an arbitrary file and either output it or use it in another GitHub Action (*step*). 🍃






	


		
💖 Support further development

		I work hard for every project, including this one and your support means a lot to me!

		


		Consider buying me a coffee. ☕

		


		Thank you for supporting my efforts! 🙏😊

		


		


		

		


		


		@igorskyflyer

		


		


	






## 🤹🏼‍♂️ Usage

In order to use this Action you need to create a YAML (`.yml`) file in your repository's `.github/workflows/` directory.

Here's an example.




`.github/workflows/read-file.yml`

```yaml

name: Read file

on:

  [push]

jobs:

  read_file:

    runs-on: ubuntu-latest # windows-latest || macos-latest

    name: Read arbitrary file

    steps:

     # do not remove this step,

     # it is necessary

      - name: Checkout repository

        uses: actions/checkout@v4

        

      - name: Read arbitrary file

        id: file

        uses: igorskyflyer/[email protected]

        with:

          path: './test.txt'

      

      - name: Output file

        env:

          FILE_CONTENTS: ${{ steps.file.outputs.content }}

        # print the output directly (1)

        # or via an environment variable (2)

        run: |

          echo 'File contents:'

          echo "${{ steps.file.outputs.content }}"

          echo "$FILE_CONTENTS"

```




## ⚙️ Configuration

`path: string`, **required**

The path of the file to read, relative to the current working directory i.e. the repository where the Action is installed.

---

## 🪪 License

Licensed under the MIT license which is available here, [MIT license](https://github.com/igorskyflyer/action-readfile/blob/main/LICENSE).

---

## 🧬 Related

[simple-exec](https://www.npmjs.com/package/simple-exec)

> _🕺 Command. Execution. Made. Simple. ▶_

[@igor.dvlpr/recursive-readdir](https://www.npmjs.com/package/@igor.dvlpr/recursive-readdir)

> _📖 Provides recursive readdir() and readdirSync() functions. 📁_

[@igor.dvlpr/keppo](https://www.npmjs.com/package/@igor.dvlpr/keppo)

> _🎡 Parse, manage, compare and output SemVer-compatible version numbers. 🛡_

[@igor.dvlpr/odin](https://www.npmjs.com/package/@igor.dvlpr/odin)

> _🔱 Odin is an Object wrapper that allows you to create objects and set their attributes - all at once! 🔺_

[@igor.dvlpr/aria](https://www.npmjs.com/package/@igor.dvlpr/aria)

> _🧬 Meet Aria, an efficient Adblock filter list compiler, with many features that make your maintenance of Adblock filter lists a breeze! 🗡_