Add automated demo recordings #2853

jesseduffield · 2023-07-31T09:35:16Z

PR Description

We're piggybacking on our existing integration test framework to record demos that we can include in our docs. Pretty cool!

I tried to get this working in docker, and I still have that as an end-goal, but for now it requires you to run this on your own computer with some dependencies:

terminalizer (recording)
gifsicle (compression)
DejaVuSansMono Nerd Font (for icons)

To generate a demo run:

scripts/record_demo.sh <path>
e.g.
scripts/record_demo.sh pkg/integration/tests/demo/commit_and_push.go

Please check if the PR fulfills these requirements

Cheatsheets are up-to-date (run go run scripts/cheatsheet/main.go generate)
Code has been formatted (see here)
Tests have been added/updated (see here for the integration test guide)
Text is internationalised (see here)
Docs (specifically docs/Config.md) have been updated if necessary
You've read through your own file changes for silly mistakes etc

jesseduffield · 2023-07-31T10:41:14Z

demo/record-demo.sh

+if ! command -v terminalizer &> /dev/null
+then
+    echo "terminalizer could not be found"
+    echo "Install it with: npm install -g terminalizer"


Tried to get this setup in docker but it broke me

jesseduffield · 2023-07-31T10:41:32Z

demo/config.yml

+# Font family
+# You can use any font that is installed on your machine
+# in CSS-like syntax
+fontFamily: "DejaVuSansMono Nerd Font"


If you want to run this yourself you'll need to get the same font (same deal if we get it going in docker)

jesseduffield · 2023-07-31T10:41:59Z

pkg/integration/components/random.go

@@ -0,0 +1,104 @@
+package components
+
+var RandomCommitMessages = []string{


Wonder who wrote these...

We're piggybacking on our existing integration test framework to record demos that we can include in our docs

jesseduffield force-pushed the demos branch 3 times, most recently from dac8bdb to 48159c0 Compare July 31, 2023 10:40

jesseduffield commented Jul 31, 2023

View reviewed changes

jesseduffield force-pushed the demos branch 4 times, most recently from 0386a9d to 6b9464a Compare July 31, 2023 11:23

jesseduffield added the maintenance For refactorings, CI changes, tests, version bumping, etc label Jul 31, 2023

jesseduffield force-pushed the demos branch 2 times, most recently from a3e519c to b10bbb5 Compare July 31, 2023 12:30

Add demo test variant

9cc1d65

We're piggybacking on our existing integration test framework to record demos that we can include in our docs

jesseduffield force-pushed the demos branch from b10bbb5 to 9cc1d65 Compare July 31, 2023 12:33

jesseduffield changed the title ~~Add demo test variant~~ Add automated demo recordings Jul 31, 2023

jesseduffield merged commit b92c294 into master Jul 31, 2023

jesseduffield deleted the demos branch July 31, 2023 12:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add automated demo recordings #2853

Add automated demo recordings #2853

jesseduffield commented Jul 31, 2023 •

edited

Loading

jesseduffield Jul 31, 2023

jesseduffield Jul 31, 2023

jesseduffield Jul 31, 2023

		@@ -0,0 +1,104 @@
		package components

		var RandomCommitMessages = []string{

Add automated demo recordings #2853

Add automated demo recordings #2853

Conversation

jesseduffield commented Jul 31, 2023 • edited Loading

jesseduffield Jul 31, 2023

Choose a reason for hiding this comment

jesseduffield Jul 31, 2023

Choose a reason for hiding this comment

jesseduffield Jul 31, 2023

Choose a reason for hiding this comment

jesseduffield commented Jul 31, 2023 •

edited

Loading