Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jaywcjlove/github-action-modify-file-content
Replace text content and submit content
https://github.com/jaywcjlove/github-action-modify-file-content
actions github-actions github-api
Last synced: 2 months ago
JSON representation
Replace text content and submit content
- Host: GitHub
- URL: https://github.com/jaywcjlove/github-action-modify-file-content
- Owner: jaywcjlove
- License: mit
- Created: 2022-10-26T11:01:56.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-07T17:17:55.000Z (10 months ago)
- Last Synced: 2024-04-15T07:22:55.883Z (9 months ago)
- Topics: actions, github-actions, github-api
- Language: TypeScript
- Homepage: https://jaywcjlove.github.io/github-action-modify-file-content
- Size: 1.4 MB
- Stars: 12
- Watchers: 3
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Modify File Content
===
[](https://jaywcjlove.github.io/#/sponsor)
[](https://github.com/jaywcjlove/github-action-modify-file-content/actions/workflows/ci.yml)
Replace text content and submit content
Here is the example: update time 2024-06-25 15:56:51
Here is the different delimiter example: different `GAMFC_TABEL` & `GAMFC_TABEL-END` (test)
## Inputs
- `token` Your `GITHUB_TOKEN`. This is required. Why do we need `token`? Read more here: [About the GITHUB_TOKEN secret](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token#about-the-github_token-secret). Default: `${{ github.token }}`
- `body` what needs to be replaced
- `path` file to be replaced
- `branch` The branch where the files are committed. Default: `${{ github.ref_name }}`
- `ref` The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)
- `overwrite` Overwrite the entire file content, by default `false`
- `sync_local_file` Sync local file content, by default `true`
- `message` The commit message. by default `doc: update .`
- `committer_name` The name of the author or committer of the commit. by default `github-actions[bot]`
- `committer_email` The email of the author or committer of the commit. by default `github-actions[bot]@users.noreply.github.com`
- `openDelimiter` Character to use for opening delimiter, by default "<\!--GAMFC-->"
- `closeDelimiter` Character to use for closing delimiter, by default "<\!--GAMFC-END-->"
## Outputs
- `content` text file content
## Example Usage
```yml
- name: Modify README.md
uses: jaywcjlove/github-action-modify-file-content@main
with:
path: README.md
```
`README.md` file content
```markdown
update time 2024-06-25 15:56:51
```
Replace the content between `2024-06-25 15:56:51`.
### format date
```yml
- name: Modify README.md
uses: jaywcjlove/github-action-modify-file-content@main
with:
path: README.md
body: "{{date:YYYY-MM-DD HH:mm:ss}}"
```
### overwrite file
```yml
- name: Modify README.md
uses: jaywcjlove/github-action-modify-file-content@main
with:
path: README.md
body: "overwrite file content {{date:YYYY-MM-DD HH:mm:ss}}",
overwrite: 'true'
```
### specify branch changes
```yml
- name: Modify test test/overwrite.file.md
uses: jaywcjlove/github-action-modify-file-content@main
with:
branch: test
path: test/overwrite.file.md
body: "{{date:YYYY-MM-DD HH:mm:ss}}"
overwrite: 'true'
```
## See Also
- [Github Release Changelog Generator](https://github.com/jaywcjlove/changelog-generator) A GitHub Action that compares the commit differences between two branches
- [Create Tags From](https://github.com/jaywcjlove/create-tag-action) Auto create tags from commit or package.json.
- [Github Action Contributors](https://github.com/jaywcjlove/github-action-contributors) Github action generates dynamic image URL for contributor list to display it!
- [Generated Badges](https://github.com/jaywcjlove/generated-badges) Create a badge using GitHub Actions and GitHub Workflow CPU time (no 3rd parties servers)
- [Create Coverage Badges](https://github.com/jaywcjlove/coverage-badges-cli) Create coverage badges from coverage reports. (no 3rd parties servers)
- [Github Action package](https://github.com/jaywcjlove/github-action-package) Read and modify the contents of `package.json`.
- [Github Action EJS](https://github.com/jaywcjlove/github-action-package) A github action to render a ejs template using github context.
- [Github Action Read File Content](https://github.com/jaywcjlove/github-action-read-file)
Read file contents. You can also get the file content in the branch.
## License
Licensed under the MIT License.