Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jaywcjlove/action-ejs
A github action to render a ejs template using github context
https://github.com/jaywcjlove/action-ejs
actions ejs github-actions
Last synced: 3 months ago
JSON representation
A github action to render a ejs template using github context
- Host: GitHub
- URL: https://github.com/jaywcjlove/action-ejs
- Owner: jaywcjlove
- License: mit
- Created: 2022-03-17T01:32:36.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-12T05:47:37.000Z (8 months ago)
- Last Synced: 2024-05-23T01:13:47.490Z (8 months ago)
- Topics: actions, ejs, github-actions
- Language: TypeScript
- Homepage: https://jaywcjlove.github.io/action-ejs
- Size: 656 KB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Action EJS
===
[](https://jaywcjlove.github.io/#/sponsor)
[](https://github.com/jaywcjlove/action-ejs/actions/workflows/ci.yml)
[](https://github.com/jaywcjlove/action-ejs/actions/workflows/test.yml)
A github action to render a [`ejs`](https://github.com/mde/ejs) template using github context
## Usage
```yml
- name: action-ejs
uses: jaywcjlove/action-ejs@main
with:
template:
<%= name %> <%= conclusion %>
vars: |
{ "name": "${{ github.repository }}", "conclusion": "${{ steps.ejs.conclusion }}" }
```
```yml
- name: action-ejs
uses: jaywcjlove/action-ejs@main
with:
template:
<%= LICENSE %><%= markdown %>
output: build/demo.html
vars-file: |
{
"markdown": "./README.md",
"LICENSE": "./LICENSE"
}
```
```yml
- name: action-ejs
uses: jaywcjlove/action-ejs@main
with:
template-file: template/demo.html
output: build/template/demo.html
vars: |
{ "htmlContent": "${{ env.GITHUB_REF }}" }
```
Following objects are exposed, and can be used in template file:
- `context`: The [Context](https://github.com/actions/toolkit/blob/main/packages/github/src/context.ts) object in [@actions/github](https://github.com/actions/toolkit/tree/main/packages/github)
- `process`: The `process.env` object. You can access the environment variables with `env.`
```yml
- name: action-ejs
uses: jaywcjlove/action-ejs@main
with:
template: |
<%= env.GITHUB_REF %>
commiter: <%= context.payload.head_commit.author.name %>
```
## Inputs
- `template` Input ESJ template string.
- `template-file` Input ESJ template file path.
- `vars` Input variables. A dictionary of variables in JSON format to be used in the template. `default: '{}'`
- `vars-file` Read the contents of the file into a `vars`. `default: '{}'`
- `options` A JSON format string of options to be passed to the template engine. `default: '{}'`
- `output` output html path `default: build/index.html`
## Outputs
- `content` template render result: `....`.
## See Also
- [Github Release Changelog Generator](https://github.com/jaywcjlove/changelog-generator) A GitHub Action that compares the commit differences between two branches
- [Create Tags From](https://github.com/jaywcjlove/create-tag-action) Auto create tags from commit or package.json.
- [Github Action Contributors](https://github.com/jaywcjlove/github-action-contributors) Github action generates dynamic image URL for contributor list to display it!
- [Generated Badges](https://github.com/jaywcjlove/generated-badges) Create a badge using GitHub Actions and GitHub Workflow CPU time (no 3rd parties servers)
- [Create Coverage Badges](https://github.com/jaywcjlove/coverage-badges-cli) Create coverage badges from coverage reports. (no 3rd parties servers)
- [Github Action package](https://github.com/jaywcjlove/github-action-package) Read and modify the contents of `package.json`.
## Contributors
As always, thanks to our amazing contributors!
Made with [action-contributors](https://github.com/jaywcjlove/github-action-contributors).
## License
Licensed under the MIT License.