Read File Content

Read file contents. You can also get the file content in the branch

Example Usage

- name: Read README.md
  id: package
  uses: jaywcjlove/github-action-read-file@main
  with:
    path: package.json

- name: Echo package.json
  run: echo "${{ steps.package.outputs.content }}"

Specify the branch to read the file content

- name: Read README.md(gh-pages)
  id: ghpages
  uses: jaywcjlove/github-action-read-file@main
  with:
    branch: gh-pages
    path: README.md

- name: Echo README.md(gh-pages)
  run: echo "${{ steps.ghpages.outputs.content }}"

Inputs

• path File path. E.g: src/index.ts
• branch The branch where the file resides. Default: ${{ github.ref_name }}, E.g: main, gh-pages
• localfile Local File path. E.g: src/index.ts

Outputs

• content text file content
• type
• encoding
• name
• path
• sha
• size file size
• url Format: uri
• git_url Format: uri
• html_url Format: uri
• download_url Format: uri
• target @example "actual/actual.md"
• submodule_git_url @example "git://example.com/defunkt/dotjs.git"

See Also

• Github Release Changelog Generator A GitHub Action that compares the commit differences between two branches
• Create Tags From Auto create tags from commit or package.json.
• Github Action Contributors Github action generates dynamic image URL for contributor list to display it!
• Generated Badges Create a badge using GitHub Actions and GitHub Workflow CPU time (no 3rd parties servers)
• Create Coverage Badges Create coverage badges from coverage reports. (no 3rd parties servers)
• Github Action package Read and modify the contents of package.json.
• Github Action EJS A github action to render a ejs template using github context.
• Modify File Content Replace text content and submit content.

License

Licensed under the MIT License.