Add GIFs to CI via vhs-action #3810
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nekevss
added
documentation
Test262 conformance changes
|
jedel1043
reviewed
Apr 15, 2024
.github/workflows/artifacts.yml
Outdated
Comment on lines
9
to
31
| build_cli_tape: | ||
| name: Generate boa_cli GIF | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 60 | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: dtolnay/rust-toolchain@stable | ||
| - run: cargo install --path ./cli | ||
| # Below is from vhs-actions examples | ||
| # https://github.com/charmbracelet/vhs-action/blob/main/examples/auto-commit.yml | ||
| - uses: charmbracelet/vhs-action@v1 | ||
| with: | ||
| path: './.github/tapes/boa_cli.tape' | ||
| - uses: stefanzweifel/git-auto-commit-action@v4 | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| with: | ||
| commit_message: Update generated VHS GIF | ||
| branch: main | ||
| commit_user_name: vhs-action 📼 | ||
| commit_user_email: [email protected] | ||
| commit_author: vhs-action 📼 <[email protected]> | ||
| file_pattern: '*.gif' |
There was a problem hiding this comment.
Was thinking more about this, and maybe this shouldn't be a direct commit, but a check on the PRs that compares the current version of the GIF with the GIF generated by the tool, and throws if both differ.
nekevss
force-pushed
the
add-vhs-ci
branch
2 times, most recently
from
d88ac4c to
9282888
Compare
|
We could maybe only enable it for PRs, since when we merge into main, we squash the commits. That would make it easier to preserve a reasonable history. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This Pull Request is to propose adding a GIF to
boa_cliand thevhs-actionCI to update the GIF in CI.With
vhs-action, we could also look into automating more GIFs for our docs that can be built out during the artifacts CI.The one unfortunate thing is that the GIF generation for
boa_cliwon't take in any changes fromboa_engineas it is set to the currently released version in it'sCargo.toml.I am also a bit concerned about
stefanzweifel/git-auto-commit-action@v4as I'm not entirely sure how it will affect the commit history.EDIT: VHS can be found here for reference