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

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/action-readfile@v1.0.0
        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.

---

🧬 Related

simple-exec

🕺 Command. Execution. Made. Simple. ▶

@igor.dvlpr/recursive-readdir

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

@igor.dvlpr/keppo

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

@igor.dvlpr/odin

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

@igor.dvlpr/aria

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