https://github.com/charmbracelet/vhs-action

Keep your GIFs up to date with VHS + GitHub actions 📽️
https://github.com/charmbracelet/vhs-action

actions gifs github terminal vhs

Last synced: 20 days ago
JSON representation

Keep your GIFs up to date with VHS + GitHub actions 📽️

• Host: GitHub
• URL: https://github.com/charmbracelet/vhs-action
• Owner: charmbracelet
• License: mit
• Created: 2022-10-24T15:58:46.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-23T23:50:53.000Z (about 1 month ago)
• Last Synced: 2024-12-27T04:07:16.643Z (28 days ago)
• Topics: actions, gifs, github, terminal, vhs
• Language: TypeScript
• Homepage:
• Size: 4.15 MB
• Stars: 189
• Watchers: 3
• Forks: 7
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# VHS Action

Keep your GIFs up to date with VHS + GitHub actions 📽️

![vhs-action-banner](https://stuff.charm.sh/vhs/vhs-action-banner.png)



The above GIF is automatically generated on CI with GitHub actions and VHS.

## Getting Started

To get started with GitHub actions you can [read the documentation](https://docs.github.com/en/actions).

To add `vhs-action` to your project you will need to:

1. Create `.github/workflows/vhs.yml` in your project directory.

2. Copy one of the [`examples/`](./examples/) into your `vhs.yml`.

3. Create your tape files with the instructions to perform (See [VHS][vhs] instructions on `.tape` files)

4. Trigger your action by creating a pull request or making a commit depending on your `vhs.yml` file.

That's all! Anytime the action is triggered, GitHub actions and VHS will regenerate the GIF from your `.tape` file on CI.

This is useful for keeping demos updated and performing integration testing to catch errors in your PRs.

## Inputs

| Name            | Description                    | Default                                                 |

| --------------- | ------------------------------ | ------------------------------------------------------- |

| `path`          | Path of the VHS `.tape` file   | `""` (install VHS without running it)                   |

| `version`       | Version of VHS to use          | `"latest"`                                              |

| `token`         | GitHub token to use            | `"${{ github.token }}"`                                 |

| `install-fonts` | Whether to install extra fonts | `"false"`                                               |

The action provides `JetBrains Mono` by default. Extra fonts (and their

[nerd font][nerdfonts] variations) can be installed by setting `install-fonts`

to `true`.

Extra fonts

- Bitstream Vera Sans Mono

- DejaVu

- Fira Code

- Hack

- IBM Plex Mono

- Inconsolata

- Liberation

- Roboto Mono

- Source Code Pro

- Ubuntu Mono

## Examples

- Auto-commit latest generated GIF file ([example](./examples/auto-commit.yml))

- Upload GIF to host and comment generated GIF on a pull request ([example](./examples/comment-pr.yml))

## Feedback

We’d love to hear your thoughts on this project. Feel free to drop us a note!

- [Twitter](https://twitter.com/charmcli)

- [The Fediverse](https://mastodon.social/@charmcli)

- [Discord](https://charm.sh/chat)

## License

[MIT](https://github.com/charmbracelet/vhs/raw/main/LICENSE)

---

Part of [Charm](https://charm.sh).



  



Charm热爱开源 • Charm loves open source

[vhs]: https://github.com/charmbracelet/vhs

[nerdfonts]: https://www.nerdfonts.com