Skip to content

Commit

Permalink
doc: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jaywcjlove committed Nov 30, 2022
1 parent 0ac0040 commit 9f30110
Showing 1 changed file with 21 additions and 21 deletions.
42 changes: 21 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,6 @@ Read File Content

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

## 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`

## 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"

## Example Usage

```yml
Expand Down Expand Up @@ -51,6 +30,27 @@ Specify the **branch** to read the file content
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`

## 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](https://github.com/jaywcjlove/changelog-generator) A GitHub Action that compares the commit differences between two branches
Expand Down

0 comments on commit 9f30110

Please sign in to comment.