https://github.com/metaory/svg-timeline-diagram-action
🚧 Generates and commits SVG Timeline Diagrams from your data
https://github.com/metaory/svg-timeline-diagram-action
Last synced: 3 months ago
JSON representation
🚧 Generates and commits SVG Timeline Diagrams from your data
- Host: GitHub
- URL: https://github.com/metaory/svg-timeline-diagram-action
- Owner: metaory
- License: mit
- Created: 2024-12-29T07:50:32.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-12-29T08:34:22.000Z (6 months ago)
- Last Synced: 2025-01-30T17:07:01.168Z (5 months ago)
- Language: Shell
- Homepage:
- Size: 2.93 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SVG Timeline Diagram Action
Generates and commits SVG Timeline Diagrams from your data
---
> [!CAUTION]
> ```
> $$\ $$\ $$$$$$\ $$$$$$$\
> $$ | $\ $$ |\_$$ _|$$ __$$\
> $$ |$$$\ $$ | $$ | $$ | $$ |
> $$ $$ $$\$$ | $$ | $$$$$$$ |
> $$$$ _$$$$ | $$ | $$ ____/
> $$$ / \$$$ | $$ | $$ |
> $$ / \$$ |$$$$$$\ $$ |
> \__/ \__|\______|\__|
> @1735500000 🚧
> ```
---
## Features
- 🔄 Generates SVG files from input data
- 🚀 Can be triggered manually or on file changes
- 💾 Automatically commits generated SVGs
## Usage
```yaml
name: Generate SVG Timeline Diagram
on:
push:
paths:
- 'data/**' # Trigger on data file changes
workflow_dispatch: # Allow manual triggers
jobs:
generate:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Generate Timeline diagram
- uses: metaory/svg-timeline-action@v1
with:
input-path: ./data/input.json
output-path: ./assets/output.svg
commit-message: 'chore: update visualization'
```
## Inputs
| Input | Description | Required | Default |
|------------------|--------------------------------------|----------|-------------------------------|
| `input-path` | Path to input file or directory | No | . |
| `output-path` | Where to save the generated SVG | No | ./output.svg |
| `commit-message` | Commit message for the generated SVG | No | 'chore: update generated SVG' |
## Examples
### Basic Usage
```yaml
- uses: metaory/svg-timeline-action@v1
with:
input-path: ./data/stats.json
```
### Custom Output Location
```yaml
- uses: metaory/svg-timeline-action@v1
with:
input-path: ./data/stats.json
output-path: ./assets/timeline.svg
```
---
LICENSE
-------
[MIT](LICENSE)