Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add automated demo recordings #2853

Merged
merged 1 commit into from
Jul 31, 2023
Merged

Add automated demo recordings #2853

merged 1 commit into from
Jul 31, 2023

Conversation

jesseduffield
Copy link
Owner

@jesseduffield jesseduffield commented Jul 31, 2023 •
edited

  • 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

demo-compressed

  • 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
jesseduffield commented Jul 31, 2023
View reviewed changes
demo/record-demo.sh Outdated
if ! command -v terminalizer &> /dev/null
then
echo "terminalizer could not be found"
echo "Install it with: npm install -g terminalizer"
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tried to get this setup in docker but it broke me

jesseduffield
jesseduffield commented Jul 31, 2023
View reviewed changes
demo/config.yml
# Font family
# You can use any font that is installed on your machine
# in CSS-like syntax
fontFamily: "DejaVuSansMono Nerd Font"
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
jesseduffield commented Jul 31, 2023
View reviewed changes
pkg/integration/components/random.go
@@ -0,0 +1,104 @@
package components

var RandomCommitMessages = []string{
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wonder who wrote these...

@jesseduffield jesseduffield added the maintenance For refactorings, CI changes, tests, version bumping, etc label Jul 31, 2023
@jesseduffield
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 jesseduffield changed the title Add demo test variant Add automated demo recordings Jul 31, 2023
@jesseduffield jesseduffield merged commit b92c294 into master Jul 31, 2023
12 checks passed
@jesseduffield jesseduffield deleted the demos branch July 31, 2023 12:43
renovate bot added a commit to scottames/dots that referenced this pull request Aug 5, 2023
@renovate
chore(deps): update aqua (#82)
cb2ce84 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
|
[GoogleContainerTools/skaffold](https://github.com/GoogleContainerTools/skaffold)
| patch | `v2.6.2` -> `v2.6.3` |
| [ajeetdsouza/zoxide](https://github.com/ajeetdsouza/zoxide) | patch
| `v0.9.1` -> `v0.9.2` |
| [aquaproj/aqua-registry](https://github.com/aquaproj/aqua-registry)
| patch | `v4.32.0` -> `v4.32.2` |
| [jesseduffield/lazygit](https://github.com/jesseduffield/lazygit) |
minor | `v0.39.4` -> `v0.40.0` |
| [weaveworks/eksctl](https://github.com/weaveworks/eksctl) | minor |
`v0.150.0` -> `v0.151.0` |

---

### Release Notes

<details>
<summary>GoogleContainerTools/skaffold
(GoogleContainerTools/skaffold)</summary>

###
[`v2.6.3`](https://github.com/GoogleContainerTools/skaffold/releases/tag/v2.6.3):
Release

[Compare
Source](https://github.com/GoogleContainerTools/skaffold/compare/v2.6.2...v2.6.3)

##### v2.6.3 Release - 2023-08-04

**Linux amd64**
`curl -Lo skaffold
https://storage.googleapis.com/skaffold/releases/v2.6.3/skaffold-linux-amd64
&& chmod +x skaffold && sudo mv skaffold /usr/local/bin`

**Linux arm64**
`curl -Lo skaffold
https://storage.googleapis.com/skaffold/releases/v2.6.3/skaffold-linux-arm64
&& chmod +x skaffold && sudo mv skaffold /usr/local/bin`

**macOS amd64**
`curl -Lo skaffold
https://storage.googleapis.com/skaffold/releases/v2.6.3/skaffold-darwin-amd64
&& chmod +x skaffold && sudo mv skaffold /usr/local/bin`

**macOS arm64**
`curl -Lo skaffold
https://storage.googleapis.com/skaffold/releases/v2.6.3/skaffold-darwin-arm64
&& chmod +x skaffold && sudo mv skaffold /usr/local/bin`

**Windows**

https://storage.googleapis.com/skaffold/releases/v2.6.3/skaffold-windows-amd64.exe

**Docker image**
`gcr.io/k8s-skaffold/skaffold:v2.6.3`

**Full Changelog**:
GoogleContainerTools/skaffold@v2.6.2...v2.6.3

</details>

<details>
<summary>ajeetdsouza/zoxide (ajeetdsouza/zoxide)</summary>

###
[`v0.9.2`](https://github.com/ajeetdsouza/zoxide/releases/tag/v0.9.2):
0.9.2

[Compare
Source](https://github.com/ajeetdsouza/zoxide/compare/v0.9.1...v0.9.2)

##### Added

-   Short option `-a` for `zoxide query --all`.

##### Fixed

-   PowerShell: use `global` scope for variables / functions.

</details>

<details>
<summary>aquaproj/aqua-registry (aquaproj/aqua-registry)</summary>

###
[`v4.32.2`](https://github.com/aquaproj/aqua-registry/releases/tag/v4.32.2)

[Compare
Source](https://github.com/aquaproj/aqua-registry/compare/v4.32.1...v4.32.2)


[Issues](https://github.com/aquaproj/aqua-registry/issues?q=is%3Aissue+milestone%3Av4.32.2)
| [Pull
Requests](https://github.com/aquaproj/aqua-registry/pulls?q=is%3Apr+milestone%3Av4.32.2)
| aquaproj/aqua-registry@v4.32.1...v4.32.2

##### Fixes


[#&#8203;14327](https://github.com/aquaproj/aqua-registry/issues/14327)
Rename kyleconroy/sqlc to sqlc-dev/sqlc as of repository migration
[@&#8203;ichizero](https://github.com/ichizero)

[#&#8203;14339](https://github.com/aquaproj/aqua-registry/issues/14339)
sqlc-dev/sqlc: Support old versions

###
[`v4.32.1`](https://github.com/aquaproj/aqua-registry/releases/tag/v4.32.1)

[Compare
Source](https://github.com/aquaproj/aqua-registry/compare/v4.32.0...v4.32.1)


[Issues](https://github.com/aquaproj/aqua-registry/issues?q=is%3Aissue+milestone%3Av4.32.1)
| [Pull
Requests](https://github.com/aquaproj/aqua-registry/pulls?q=is%3Apr+milestone%3Av4.32.1)
| aquaproj/aqua-registry@v4.32.0...v4.32.1

#### Fixes


[#&#8203;14275](https://github.com/aquaproj/aqua-registry/issues/14275)
[#&#8203;14276](https://github.com/aquaproj/aqua-registry/issues/14276)
[#&#8203;14277](https://github.com/aquaproj/aqua-registry/issues/14277)
[#&#8203;14278](https://github.com/aquaproj/aqua-registry/issues/14278)
[domoritz/arrow-tools/{csv2arrow,csv2parquet,json2arrow,json2parquet}](https://github.com/domoritz/arrow-tools):
Follow up changes of asset names

</details>

<details>
<summary>jesseduffield/lazygit (jesseduffield/lazygit)</summary>

###
[`v0.40.0`](https://github.com/jesseduffield/lazygit/releases/tag/v0.40.0)

[Compare
Source](https://github.com/jesseduffield/lazygit/compare/v0.39.4...v0.40.0)

<!-- Release notes generated using configuration in .github/release.yml
at v0.40.0 -->

### 🎉  LAZYGIT FIVE YEAR ANNIVERSARY EDITION 🎉

Holy moly, has it really been 5 years since Lazygit's birth? Time flies
when you're having fun.

I've written a post celebrating the anniversary
[here](https://jesseduffield.com/Lazygit-5-Years-On).

As for this release, we've got some great features here.

##### Worktrees

We now have a worktrees view so you can easily create worktrees and
switch to them and so on. I'm not a big worktrees user myself so please
raise an issue if you can think of places to improve the UX.


![worktree_create_from_branches-compressed](https://github.com/jesseduffield/lazygit/assets/8456633/3ef0b085-e9d0-42de-af58-16cbae581d34)

##### Rebase --onto

Rebasing onto a marked base commit is a very useful feature that we've
been sorely lacking for a while
(demo coming soon)

##### Auto-refresh on window focus

Auto-refresh on window activation is a complete game-changer. No more
having to manually press shift+R when you come back from your editor.

##### Nuking the worktree

We also have a fun enhancement in this release: showing an explosion
animation when you nuke the working tree.


![nuke-gif](https://github.com/jesseduffield/lazygit/assets/8456633/32b3f91c-fea3-474d-8997-1de2f5e4f5d4)

You'll also notice in the readme we've got some updated demo gifs to
showoff Lazygit's features. More of those to come.

#### What's Changed

##### Features ✨

- Add worktrees view by
[@&#8203;jesseduffield](https://github.com/jesseduffield) (with help
from [@&#8203;kadaan](https://github.com/kadaan)) in
[jesseduffield/lazygit#2147
- Rebase onto branch from a marked base commit by
[@&#8203;stefanhaller](https://github.com/stefanhaller) in
[jesseduffield/lazygit#2835
- Auto-refresh on window activation by
[@&#8203;stefanhaller](https://github.com/stefanhaller) in
[jesseduffield/lazygit#2854

##### Enhancements 🔥

- Faster refresh by
[@&#8203;jesseduffield](https://github.com/jesseduffield) in
[jesseduffield/lazygit#2841
- feat: add os.copyToClipboardCmd to allow for a custom command
[#&#8203;1055](https://github.com/jesseduffield/lazygit/issues/1055)
by [@&#8203;redstreet](https://github.com/redstreet) in
[jesseduffield/lazygit#2784
- Add bisect menu entry that lets you choose bisect terms by
[@&#8203;stefanhaller](https://github.com/stefanhaller) in
[jesseduffield/lazygit#2838
- When bisecting, always mark the current commit as good/bad, not the
selected by [@&#8203;stefanhaller](https://github.com/stefanhaller) in
[jesseduffield/lazygit#2837
- Visualize local branch heads in commits panel, 2nd approach by
[@&#8203;stefanhaller](https://github.com/stefanhaller) in
[jesseduffield/lazygit#2775
- Allow force-tagging if tag exists by
[@&#8203;stefanhaller](https://github.com/stefanhaller) in
[jesseduffield/lazygit#2827
- Save IgnoreWhitespaceInDiffView in state.yml by
[@&#8203;stefanhaller](https://github.com/stefanhaller) in
[jesseduffield/lazygit#2830
- Show loader when rebasing by
[@&#8203;KarlHeitmann](https://github.com/KarlHeitmann) in
[jesseduffield/lazygit#2851
- Internationalise logging of commands by
[@&#8203;KarlHeitmann](https://github.com/KarlHeitmann) in
[jesseduffield/lazygit#2852
- Show visual explosion effect when nuking worktree by
[@&#8203;jesseduffield](https://github.com/jesseduffield) in
[jesseduffield/lazygit#2861

##### Fixes 🔧

- Fix issue where using `null` to un-map a keybinding was ignored by
[@&#8203;hatredholder](https://github.com/hatredholder) in
[jesseduffield/lazygit#2832
- Show error when trying to open patch menu with an empty patch by
[@&#8203;stefanhaller](https://github.com/stefanhaller) in
[jesseduffield/lazygit#2829
- Fix merge status for update-ref command by
[@&#8203;stefanhaller](https://github.com/stefanhaller) in
[jesseduffield/lazygit#2845
- Stop worktrees view from stealing the window by
[@&#8203;jesseduffield](https://github.com/jesseduffield) in
[jesseduffield/lazygit#2863
- Fix confirmation view sizing by
[@&#8203;jesseduffield](https://github.com/jesseduffield) in
[jesseduffield/lazygit#2879

##### Maintenance ⚙️

- Standardise on using lo for slice functions by
[@&#8203;jesseduffield](https://github.com/jesseduffield) in
[jesseduffield/lazygit#2846
- Remove redundant secureexec package by
[@&#8203;jesseduffield](https://github.com/jesseduffield) in
[jesseduffield/lazygit#2847
- Add automated demo recordings by
[@&#8203;jesseduffield](https://github.com/jesseduffield) in
[jesseduffield/lazygit#2853
- Remove file watcher code by
[@&#8203;jesseduffield](https://github.com/jesseduffield) in
[jesseduffield/lazygit#2865
- Add more demos to the README by
[@&#8203;jesseduffield](https://github.com/jesseduffield) in
[jesseduffield/lazygit#2866
- Move features to top of readme by
[@&#8203;jesseduffield](https://github.com/jesseduffield) in
[jesseduffield/lazygit#2867
- Add more demos by
[@&#8203;jesseduffield](https://github.com/jesseduffield) in
[jesseduffield/lazygit#2874

##### Other Changes

- Create demo output dir if it doesn't already exist by
[@&#8203;jesseduffield](https://github.com/jesseduffield) in
[jesseduffield/lazygit#2857

#### New Contributors

- [@&#8203;hatredholder](https://github.com/hatredholder) made their
first contribution in
[jesseduffield/lazygit#2832
- [@&#8203;redstreet](https://github.com/redstreet) made their first
contribution in
[jesseduffield/lazygit#2784
- [@&#8203;kadaan](https://github.com/kadaan) made their first
contribution in
[jesseduffield/lazygit#2147
- [@&#8203;KarlHeitmann](https://github.com/KarlHeitmann) made their
first contribution in
[jesseduffield/lazygit#2851

**Full Changelog**:
jesseduffield/lazygit@v0.39.4...v0.40.0

</details>

<details>
<summary>weaveworks/eksctl (weaveworks/eksctl)</summary>

###
[`v0.151.0`](https://github.com/eksctl-io/eksctl/releases/tag/v0.151.0):
eksctl 0.151.0 (permalink)

[Compare
Source](https://github.com/weaveworks/eksctl/compare/0.150.0...0.151.0)

### Release v0.151.0

#### 🚀 Features

- Support custom AMIs for self-managed Windows nodegroups
([#&#8203;6804](https://github.com/weaveworks/eksctl/issues/6804))
- Support custom Ubuntu AMIs for EKS-managed nodegroups
([#&#8203;6850](https://github.com/weaveworks/eksctl/issues/6850))

#### 🎯 Improvements

- Remove support for EKS 1.22
([#&#8203;6704](https://github.com/weaveworks/eksctl/issues/6704))

#### 🐛 Bug Fixes

- Fix error with tar in `Post Cache go-build and mod` step
([#&#8203;6840](https://github.com/weaveworks/eksctl/issues/6840))
- Fix setting link-time variables for release version
([#&#8203;6841](https://github.com/weaveworks/eksctl/issues/6841))
- Select one subnet for AZs where multiple are present and no VPC config
provided
([#&#8203;6814](https://github.com/weaveworks/eksctl/issues/6814))
- Paginate instance type offerings response
([#&#8203;6832](https://github.com/weaveworks/eksctl/issues/6832))

#### 🧰 Maintenance

- Bump dependencies
([#&#8203;6852](https://github.com/weaveworks/eksctl/issues/6852),
[#&#8203;6859](https://github.com/weaveworks/eksctl/issues/6859))
- Cleanup Flux Integration
([#&#8203;6836](https://github.com/weaveworks/eksctl/issues/6836))

#### Acknowledgments

Weaveworks would like to sincerely thank:
[@&#8203;watany-dev](https://github.com/watany-dev)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "after 4pm on thursday" (UTC),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the
rebase/retry checkbox.

👻 **Immortal**: This PR will be recreated if closed unmerged. Get
[config help](https://github.com/renovatebot/renovate/discussions) if
that's undesired.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/scottames/dots).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi4yNy4xIiwidXBkYXRlZEluVmVyIjoiMzYuMjcuMSIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
maintenance For refactorings, CI changes, tests, version bumping, etc
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
1 participant
@jesseduffield