[{"_1":2,"_166":-5,"_167":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_141":142},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":-5,"_85":86,"_134":-5,"_135":11,"_136":17,"_137":11,"_138":-5,"_139":140},"canonicalUrl","https://hub.docker.com/r/unfor19/replacer-action/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","unfor19","reponame","replacer-action","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":70,"_75":11,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2020-08-14T12:38:12.006345Z","description","","is_private","last_updated","2021-12-04T19:49:58.519273Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",1293,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# replacer-action\n\n[![testing](https://github.com/unfor19/replacer-action/workflows/testing/badge.svg)](https://github.com/unfor19/replacer-action/actions?query=workflow%3Atesting)\n[![test-action](https://github.com/unfor19/replacer-action-test/workflows/test-action/badge.svg)](https://github.com/unfor19/replacer-action-test/actions?query=workflow%3Atest-action)\n\n\nAuto-update README.md file according to the source code. When to use this action?\n\n- **CLI Help Menu**: Inject the *help menu* of your CLI to the *README.md* file, see [Help Menu](#help-menu)\n- **Test Results**: Share test results in your *README.md* file, see [bargs test suite](https://github.com/unfor19/bargs#usage-output)\n- **API Response**: Keep your README.md up-to-date with the response of your APIs\n\nTested in [unfor19/replacer-action-test](https://github.com/unfor19/replacer-action-test/actions?query=workflow%3Atest-action)\n\n## How It Works\n\n1. Uses [perl](https://marekbosman.com/site/perl-find-and-replace/) to manipulate the destination file - `README.md`\n2. Executes [git diff](https://git-scm.com/docs/git-diff) to check if there are any changes in `README.md`\n3. If there are no changes, exits successfully\n4. If there are changes, executes [git commit](https://git-scm.com/docs/git-commit) followed by [git push](https://git-scm.com/docs/git-push)\n\n## Requirements\n\n1. Insert a start tag and stop tag to a text file, for example\n\n```html\n\n\n

User name will appear here instead

\n\n\n```\n\n2. Prepare a file with the text that you want to inject\n\n```bash\n$ echo -e '

This is the incoming text block

\\n

It worked!

' > test_results.log\n```\n\n## Usage\n\n### GitHub Action\n\n```yaml\nname: Update README.md\non:\n push:\n branches: [master]\n # IMPORTANT: Avoids endless loop\n paths-ignore:\n - \"README.md\"\n\njobs:\n update-readme:\n runs-on: ubuntu-20.04\n steps:\n - uses: actions/checkout@v2\n - name: Prepare source file\n run: |\n echo \"

$(whoami)

\" > test_results.log\n - uses: unfor19/replacer-action@v1\n name: Update README.md file\n with:\n src-file-path: \"test_results.log\"\n dst-file-path: \"README.md\"\n start-value: \"\"\n end-value: \"\"\n git-user-name: \"replacer-action\"\n git-user-email: \"replacer-action@meirg.co.il\"\n git-commit-msg: \"Updated by GitHub Actions\"\n git-skip-commit: false\n git-skip-push: false\n create-backup: true\n```\n\n### Help Menu\n\n```bash\n./entrypoint.sh --help\n```\n\n\n\n```bash\n\nUsage: bash entrypoint.sh --help\n\n\t--src_file_path | -sf [ENV_VAR] Relative path to source file that will be injected\n\t--dst_file_path | -df [README.md] Relative path to destination file\n\t--start_value | -sv [] From where to start\n\t--end_value | -ev [] Where to stop\n\t--git_user_name | -gu [replacer-action] Actor user name\n\t--git_user_email | -ge [replacer-action.co.il] Actor email address\n\t--git_commit_msg | -gm [Updated by GitHub Actions] Git commit message\n\t--git_skip_commit | -gsc [false] Skip Git commit\n\t--git_skip_push | -gsp [false] Skip Git push\n\t--create_backup | -cb [true] Create a backup file\n```\n\n\n_NOTE_: the code block above :point_up: was automatically generated with replacer! See the raw version of this [README.md](https://raw.githubusercontent.com/unfor19/replacer-action/master/README.md) file\n\n\n### drone.io\n\n

\n\n

Expand/Collapse

\n\n```yaml\nkind: pipeline\ntype: docker\nname: testing-drone\n\nsteps:\n - name: Prepare source file\n image: alpine:3.12\n cmd: |\n echo \"

$(whoami)

\" > test_results.log\n - name: Dry run\n image: unfor19/replacer-action:latest\n settings:\n src_file_path: \"test_results.log\"\n dst_file_path: \"README.test.md\"\n start_value: \"\"\n end_value: \"\"\n git_user_name: \"Drone\"\n git_user_email: \"drone@meirg.co.il\"\n git_commit_msg: \"Updated by Drone.io\"\n git_skip_commit: false\n git_skip_push: false\n create_backup: true\n```\n\n

\n\n## Contributing\n\nReport issues/questions/feature requests on the [Issues](https://github.com/unfor19/replacer-action/issues) section.\n\nPull requests are welcome! These are the steps:\n\n1. Fork this repo\n1. Create your feature branch from master (`git checkout -b my-new-feature`)\n1. Build development image\n ```bash\n docker build -t \"replacer-action:dev\" --target \"dev\" .\n ```\n1. Run development image\n ```bash\n docker run --rm -it -v \"$PWD\":\"/code\" --workdir \"/code\" \"replacer-action:dev\"\n ```\n1. Add the code of your new feature\n1. Run tests on your code, feel free to add more tests\n ```bash\n # in container\n ./tests/test.sh\n ... # All good? Move on to the next step\n ```\n1. Commit your remarkable changes (`git commit -am 'Added new feature'`)\n1. Push to the branch (`git push --set-up-stream origin my-new-feature`)\n1. Create a new Pull Request and provide details about your changes\n\n## Authors\n\nCreated and maintained by [Meir Gabay](https://github.com/unfor19)\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](https://github.com/unfor19/replacer-action/blob/master/LICENSE) file for details\n","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",451675068,"orgData","recentTags",[87,124],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_46":113,"_114":90,"_115":29,"_116":52,"_53":117,"_118":119,"_120":104,"_121":113,"_122":62,"_123":17},"content_type","creator",6511992,"full_size",22890613,"id",113266509,"images",[97],{"_98":99,"_100":101,"_102":44,"_103":104,"_105":106,"_107":108,"_109":44,"_110":-5,"_111":92,"_59":62,"_112":-5},"architecture","amd64","digest","sha256:77e1637283d6d724791484e8322178a84d6f3e38cb6a0ff78b09a3fc19da1650","features","last_pulled","2026-09-17T21:12:19.849035476Z","last_pushed","2021-11-12T22:15:57Z","os","linux","os_features","os_version","size","variant","2021-11-12T22:15:56.310412Z","last_updater","last_updater_username","media_type","latest","repository",9636337,"tag_last_pulled","tag_last_pushed","tag_status","v2",{"_88":40,"_89":90,"_91":125,"_93":126,"_95":127,"_46":132,"_114":90,"_115":29,"_116":52,"_53":133,"_118":119,"_120":130,"_121":132,"_122":62,"_123":17},21888509,113325968,[128],{"_98":99,"_100":129,"_102":44,"_103":130,"_105":131,"_107":108,"_109":44,"_110":-5,"_111":125,"_59":62,"_112":-5},"sha256:0940ac8964c42992d0b5a8cca3108a69062fc34bbf3770bc900c73d1fca19cab","2026-09-17T21:12:20.173876078Z","2021-11-13T15:55:27Z","2021-12-04T19:49:58.16132Z","docker","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":143,"_150":151,"_139":164,"_165":11},{"_36":144,"_38":145,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":146,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":147,"_75":11,"_76":149,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":148},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_152":153,"_154":-5,"_155":-5,"_156":157},"count",2,"next","previous","results",[158,161],{"_88":40,"_89":90,"_91":125,"_93":126,"_95":159,"_46":132,"_114":90,"_115":29,"_116":52,"_53":133,"_118":119,"_120":130,"_121":132,"_122":62,"_123":17},[160],{"_98":99,"_100":129,"_102":44,"_103":130,"_105":131,"_107":108,"_109":44,"_110":-5,"_111":125,"_59":62,"_112":-5},{"_88":40,"_89":90,"_91":92,"_93":94,"_95":162,"_46":113,"_114":90,"_115":29,"_116":52,"_53":117,"_118":119,"_120":104,"_121":113,"_122":62,"_123":17},[163],{"_98":99,"_100":101,"_102":44,"_103":104,"_105":106,"_107":108,"_109":44,"_110":-5,"_111":92,"_59":62,"_112":-5},[],"canDeleteTags","actionData","errors"]

unfor19/replacer-action

Tags for unfor19/replacer-action