varst-action

GitHub Actions to replace substitutions in rst file using varST.

Example workflow

Refer example workflow if you want to replace substitutions in README.rst and push it to repository.

steps:
  - uses: actions/checkout@v3
  - name: Replace substitution
  - uses: junghoon-vans/varst-action@v2.0.0
    with:
      substitutions: 'name=value'
  - uses: stefanzweifel/git-auto-commit-action@v4

Full example is here.

Inputs

input-file

Optional The file path to read contents.

Default: ./README.rst

output-file

Optional The file path to write contents.

Default: input-file

substitutions

Required A key-value of substitutions.

If multiple values need to be defined, use the literal style, indicated by a pipe (|)

substitutions: |
  'name1=value1'
  'name2=value2'
  ...

version

Optional The version of varST to use.

If not specified, the latest version will be used.

Contributing

Contribution Guideline

Please read the contributing guidelines to learn how to contribute to this project.

Reporting Issues

If you have any questions, suggestions, or bug reports, please feel free to report them to the issue.

Code of Conduct

This project is governed by the Code of Conduct.

License

MIT License