Modify File Content

Replace text content and submit content

Here is the example: update time 2025-05-12 17:15:59

Here is the different delimiter example: different GAMFC_TABEL & GAMFC_TABEL-END (test)

Inputs

Name	Required	Default	Description
token	✅	${{ github.token }}	GitHub Token used to authenticate API requests. Why?
body	✅	—	The content to insert between delimiters in the target file.
trim_whitespace	❌	true	Trim leading and trailing whitespace in body.
path	✅	—	File path to be modified.
branch	❌	${{ github.ref_name }}	Branch to commit changes to.
ref	❌	Default branch (usually master)	The target commit, branch, or tag.
overwrite	❌	false	Whether to overwrite the entire file.
sync_local_file	❌	true	Whether to sync the file from the local content.
message	❌	doc: update <file path>.	Commit message.
committer_name	❌	github-actions[bot]	Name used for the Git commit author.
committer_email	❌	github-actions[bot]@users.noreply.github.com	Email used for the Git commit author.
openDelimiter	❌	<!--GAMFC-->2025-05-12 17:15:59<!--GAMFC-END-->	End delimiter for content replacement.

Outputs

• content text file content

Example Usage

- name: Modify README.md
  uses: jaywcjlove/github-action-modify-file-content@main
  with:
    path: README.md

README.md file content

update time <!--GAMFC-->2025-05-12 17:15:59<!--GAMFC-END-->

Replace the content between <!--GAMFC-->2025-05-12 17:15:59<!--GAMFC-END-->.

format date

- 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

- 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

- 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 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.
• Github Action Read File Content Read file contents. You can also get the file content in the branch.

Contributors

As always, thanks to our amazing contributors!

License

Licensed under the MIT License.