https://github.com/cschleiden/replace-tokens

Simple GitHub Action to replace tokens in files
https://github.com/cschleiden/replace-tokens

Last synced: about 4 hours ago
JSON representation

Simple GitHub Action to replace tokens in files

• Host: GitHub
• URL: https://github.com/cschleiden/replace-tokens
• Owner: cschleiden
• License: mit
• Created: 2019-11-07T02:40:32.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-13T13:58:51.000Z (6 months ago)
• Last Synced: 2024-04-14T05:57:07.529Z (6 months ago)
• Language: TypeScript
• Homepage: https://github.com/marketplace/actions/replace-tokens
• Size: 409 KB
• Stars: 52
• Watchers: 3
• Forks: 24
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Replace tokens

Simple GitHub Action to replace tokens in files.

## Inputs

- `files` - Glob expression, file name or array of glob/file name

- `tokenPrefix` - Prefix to use when matching tokens, defaults to `#{`

- `tokenSuffix` - Suffix to use when matching tokens, defaults to `}#`

## Example

If you want to replace `#{CDN}#` and `#{CALLBACK}#` in all of your JS files, add the action to your workflow like this:

```yml

- uses: cschleiden/replace-tokens@v1

  with:

    files: '["**/*.js"]'

  env:

    CDN: https://somecdn.com/...

    CALLBACK: some_value

```

If you want to use a different token format, you can specify a custom token prefix/suffix. For example, to replace just tokens like `{CDN}` you could add:

```yml

- uses: cschleiden/replace-tokens@v1

  with:

    tokenPrefix: '{'

    tokenSuffix: '}'

    files: '["**/*.js"]'

  env:

    CDN: https://somecdn.com/...

```

# Acknowledgements

- Inspired by the excellent https://marketplace.visualstudio.com/items?itemName=qetza.replacetokens Azure Pipelines task.

- Uses [replace-in-file](https://github.com/adamreisnz/replace-in-file) to do the actual replacement