{"id":15090126,"url":"https://github.com/igorskyflyer/action-readfile","last_synced_at":"2026-01-04T15:31:46.374Z","repository":{"id":245339698,"uuid":"817961424","full_name":"igorskyflyer/action-readfile","owner":"igorskyflyer","description":"🌬️ A GitHub Action to read an arbitrary file and either output it or use it in another GitHub Action. 🍃","archived":false,"fork":false,"pushed_at":"2024-06-21T00:06:41.000Z","size":248,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-26T11:12:46.632Z","etag":null,"topics":["action","back-end","blob","buffer","filesystem","fs","github","igorskyflyer","javascript","js","read-file","readfile","text","utility"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/read-local-file","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/igorskyflyer.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"ko_fi":"igorskyflyer"}},"created_at":"2024-06-20T20:11:05.000Z","updated_at":"2024-06-21T10:49:53.000Z","dependencies_parsed_at":"2024-06-21T14:48:53.317Z","dependency_job_id":"1ebde769-3982-4480-8fbc-811fcc1f79de","html_url":"https://github.com/igorskyflyer/action-readfile","commit_stats":null,"previous_names":["igorskyflyer/action-readfile"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igorskyflyer%2Faction-readfile","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igorskyflyer%2Faction-readfile/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igorskyflyer%2Faction-readfile/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/igorskyflyer%2Faction-readfile/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/igorskyflyer","download_url":"https://codeload.github.com/igorskyflyer/action-readfile/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244825194,"owners_count":20516587,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["action","back-end","blob","buffer","filesystem","fs","github","igorskyflyer","javascript","js","read-file","readfile","text","utility"],"created_at":"2024-09-25T09:21:43.931Z","updated_at":"2026-01-04T15:31:46.332Z","avatar_url":"https://github.com/igorskyflyer.png","language":"JavaScript","funding_links":["https://ko-fi.com/igorskyflyer"],"categories":[],"sub_categories":[],"readme":"# readfile()\n\n🌬️ A GitHub Action to read an arbitrary file and either output it or use it in another GitHub Action (*step*). 🍃\n\n\u003cbr\u003e\n\n\u003cdiv align=\"center\"\u003e\n\t\u003cblockquote\u003e\n\t\t\u003ch4\u003e💖 Support further development\u003c/h4\u003e\n\t\t\u003cspan\u003eI work hard for every project, including this one and your support means a lot to me!\n\t\t\u003cbr\u003e\n\t\tConsider buying me a coffee. ☕\n\t\t\u003cbr\u003e\n\t\t\u003cstrong\u003eThank you for supporting my efforts! 🙏😊\u003c/strong\u003e\u003c/span\u003e\n\t\t\u003cbr\u003e\n\t\t\u003cbr\u003e\n\t\t\u003ca href=\"https://ko-fi.com/igorskyflyer\" target=\"_blank\"\u003e\u003cimg src=\"https://raw.githubusercontent.com/igorskyflyer/igorskyflyer/main/assets/ko-fi.png\" alt=\"Donate to igorskyflyer\" width=\"150\"\u003e\u003c/a\u003e\n\t\t\u003cbr\u003e\n\t\t\u003cbr\u003e\n\t\t\u003ca href=\"https://github.com/igorskyflyer\"\u003e\u003cem\u003e@igorskyflyer\u003c/em\u003e\u003c/a\u003e\n\t\t\u003cbr\u003e\n\t\t\u003cbr\u003e\n\t\u003c/blockquote\u003e\n\u003c/div\u003e\n\n\u003cbr\u003e\n\n## 🤹🏼‍♂️ Usage\n\nIn order to use this Action you need to create a YAML (`.yml`) file in your repository's `.github/workflows/` directory.\n\nHere's an example.\n\n\u003cbr\u003e\n\n`.github/workflows/read-file.yml`\n```yaml\nname: Read file\n\non:\n  [push]\n\njobs:\n  read_file:\n    runs-on: ubuntu-latest # windows-latest || macos-latest\n    name: Read arbitrary file\n\n    steps:\n     # do not remove this step,\n     # it is necessary\n      - name: Checkout repository\n        uses: actions/checkout@v4\n        \n      - name: Read arbitrary file\n        id: file\n        uses: igorskyflyer/action-readfile@v1.0.0\n        with:\n          path: './test.txt'\n      \n      - name: Output file\n        env:\n          FILE_CONTENTS: ${{ steps.file.outputs.content }}\n        # print the output directly (1)\n        # or via an environment variable (2)\n        run: |\n          echo 'File contents:'\n          echo \"${{ steps.file.outputs.content }}\"\n          echo \"$FILE_CONTENTS\"\n```\n\n\u003cbr\u003e\n\n## ⚙️ Configuration\n\n`path: string`, **required**\n\nThe path of the file to read, relative to the current working directory i.e. the repository where the Action is installed.\n\n---\n\n## 🪪 License\n\nLicensed under the MIT license which is available here, [MIT license](https://github.com/igorskyflyer/action-readfile/blob/main/LICENSE).\n\n---\n\n## 🧬 Related\n\n[simple-exec](https://www.npmjs.com/package/simple-exec)\n\n\u003e _🕺 Command. Execution. Made. Simple. ▶_\n\n[@igor.dvlpr/recursive-readdir](https://www.npmjs.com/package/@igor.dvlpr/recursive-readdir)\n\n\u003e _📖 Provides recursive readdir() and readdirSync() functions. 📁_\n\n[@igor.dvlpr/keppo](https://www.npmjs.com/package/@igor.dvlpr/keppo)\n\n\u003e _🎡 Parse, manage, compare and output SemVer-compatible version numbers. 🛡_\n\n[@igor.dvlpr/odin](https://www.npmjs.com/package/@igor.dvlpr/odin)\n\n\u003e _🔱 Odin is an Object wrapper that allows you to create objects and set their attributes - all at once! 🔺_\n\n[@igor.dvlpr/aria](https://www.npmjs.com/package/@igor.dvlpr/aria)\n\n\u003e _🧬 Meet Aria, an efficient Adblock filter list compiler, with many features that make your maintenance of Adblock filter lists a breeze! 🗡_\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Figorskyflyer%2Faction-readfile","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Figorskyflyer%2Faction-readfile","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Figorskyflyer%2Faction-readfile/lists"}