Tag Replacer

GitHub Action to replace tags in files

Mergify Status

GitHub tag (latest by date) GitHub Release Date Lines of code GitHub closed issues GitHub closed pull requests GitHub repo size GitHub last commit GitHub language count GitHub Repository branches GitHub Repository dependents

Tag replacer
- Table of contents
- Description
- Inputs
  - sourceData
  - mode
    - unique
    - duplicate
  - jsonPath
  - jsonFields
  - sourceFile
  - targetPath
  - targetFile
- Outputs
  - changed
    - true
    - false
- Examples
- Visitor stats
- Licensing
- Authors
- Versioning
- Contribution
- Acknowledgement
- Forks
- Development Support

Description

Processes input file by replacing tags with provided input parameters.

Inputs

`sourceData`

Optional JSON data source file with following action parameters (just for actual example):

[
    {
        "prefix": "<!--views:info:marker:start-->\n",
        "suffix": "\n<!--views:info:marker:end-->",
        "sourceFile": "./data/info.md",
        "placeholder": "<!--views:info:marker:start-->[\\s\\S]*?<!--views:info:marker:end-->",
        "replacement": "<p align=\"center\" style=\"text-align:center;\">Info data block</p>"
    },
    {
        "prefix": "<!--views:readme:marker:start-->\n",
        "suffix": "\n<!--views:readme:marker:end-->",
        "sourceFile": "./data/readme.md",
        "placeholder": "<!--views:readme:marker:start-->[\\s\\S]*?<!--views:readme:marker:end-->",
        "replacement": "<p align=\"center\" style=\"text-align:center;\">Readme data block</p>"
    },
    {
        "prefix": "test data\n",
        "suffix": "",
        "sourceFile": "./data/test.md",
        "placeholder": "test data",
        "replacement": "<p align=\"center\" style=\"text-align:center;\">Test data block</p>"
    }
]

`prefix`

Optional String data to append before replacement

`suffix`

Optional String data to append after replacement

`sourceFile`

Required Input source file to replace in

`placeholder`

Required String placeholder or regex to replace by

`replacement`

Required String data to replace with

Outputs

`changed`

File processing operation status

`true`

When input source file successfully processed

`false`

When error occurred while processing input source file

Examples

- name: Replace file placeholders
  uses: alexrogalskiy/github-action-tag-replacer@master
  with:
    prefix: '<!--views:marker:start-->\n'
    suffix: '\n<!--views:marker:end-->'
    sourceFile: './data/info.md'
    placeholder: '<!--views:marker:start-->[\s\S]*?<!--views:marker:end-->'
    replacement: '<p align="center" style="text-align:center;">Data Block</p>'

Running locally:

npm run start:action --action github-action-tag-replacer --prefix '\n' --suffix '\n' --sourceFile './data/info.md' --placeHolder '[\s\S]*?' --replacement '<p align="center" style="text-align:center;">Data Block</p>'